https://github.com/rohlacanna/rockelivery
API for ordering from a restaurant.
https://github.com/rohlacanna/rockelivery
elixir phoenix
Last synced: about 1 year ago
JSON representation
API for ordering from a restaurant.
- Host: GitHub
- URL: https://github.com/rohlacanna/rockelivery
- Owner: rohlacanna
- License: mit
- Created: 2021-11-25T14:53:36.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-05-12T12:37:26.000Z (about 4 years ago)
- Last Synced: 2023-03-06T19:17:42.088Z (over 3 years ago)
- Topics: elixir, phoenix
- Language: Elixir
- Homepage:
- Size: 167 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Rockelivery
Order your favorite dish in no time!
Created with Elixir and Phoenix.
Made with ❤️
# :pushpin: Contents
- [Features](#rocket-features)
- [Installation](#wrench-installation)
- [Getting started](#bulb-getting-started)
- [Techs](#fire-techs)
- [Issues](#bug-issues)
- [License](#book-license)
# :rocket: 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
# :wrench: Installation
### Required :warning:
- 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 git@github.com: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**
# :bulb: 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
# :fire: Techs
### Elixir (language)
### Phoenix (web framework)
- Ecto
- Elixir GenServer (orders report)
- Guardian (authentication)
- PBKDF2 (password cryptography)
- Tesla (http client to external apis)
# :bug: Issues
Find a bug or error on the project? Please, feel free to send me the issue on the [Rockelivery issues area](https://github.com/rohlacanna/Rockelivery/issues), 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!
# :book: License
Released in 2022.
This project is under the [MIT license](https://github.com/rohlacanna/Rockelivery/blob/main/LICENSE).
< keep coding /> :rocket: :heart: