Rockelivery

Order your favorite dish in no time!
Created with Elixir and Phoenix.
_{Made with ❤️}

📌 Contents

• Features
• Installation
• Getting started
• Techs
• Issues
• License

🚀 Features

• Create, delete and updates users
• Sign-in with JWT authentication
• Create, delete and updates items
• Create orders from your favorite dishes
• Delete and update orders
• Generate an Orders Report for every hour to keep in track with your application

🔧 Installation

Required ⚠️

• Elixir
• Erlang
• Phoenix
• Postgres database

SSH

SSH URLs provide access to a Git repository via SSH, a secure protocol. If you have an SSH key registered in your GitHub account, clone the project using this command:

git clone [email protected]:rohlacanna/rockelivery.git

HTTPS

In case you don't have an SSH key on your GitHub account, you can clone the project using the HTTPS URL, run this command:

git clone https://github.com/rohlacanna/rockelivery.git

Both of these commands will generate a folder called Rockelivery, with all the project

💡 Getting started

1. Run mix deps.get to install the dependencies
2. Create a postgres database named rockelivery
3. On the config/dev.exs and config/test.exs files, change your postgres user and password
4. Run mix ecto.migrate to run the migrations to your database
5. Run mix phx.server to start the server on port 4000

🔥 Techs

Elixir (language)

Phoenix (web framework)

• Ecto
• Elixir GenServer (orders report)
• Guardian (authentication)
• PBKDF2 (password cryptography)
• Tesla (http client to external apis)

🐛 Issues

Find a bug or error on the project? Please, feel free to send me the issue on the Rockelivery issues area, with a title and a description of your found!

If you know the origin of the error and know how to resolve it, please, send me a pull request, I will love to review it!

📖 License

Released in 2022.

This project is under the MIT license.

< keep coding /> 🚀 ❤️