Control restaurants' supplies about to due 🥓

📖 About

This project is a simple API to control restaurants' supplies that are about to due in the current week and send email to the restaurants' managers with the list of supplies.

This project was developed in Next Level Week as the final project.

🏵️ API Routes

GET - api/supplies/{id}
GET - api/supplies
POST - api/restaurants
POST - api/supplies

🧱 This project was built with:

• Elixir
• Phoenix
• Ecto
• Bamboo
• Excoveralls
• Credo
• Postgres

🏃‍♂️ Installing and Running

1. Clone this repository git clone https://github.com/pferreirafabricio/inmana.git;
2. Enter in the project's folder: cd inmana
3. Install all project's dependencies: mix deps.get
4. Create and migrate your database with mix ecto.setup
5. Start Phoenix endpoint with mix phx.server
6. Finally you can visit localhost:4000 from your browser 😃

♻️ Contribute

1. Fork this repository;
2. Create a branch with your feature: git checkout -b my-feature
3. Commit your changes: git commit -m 'feat: My new feature'
4. Push your branch: git push origin my-feature

📃 License

This project is under the MIT license. Take a look at the LICENSE file for more details.

📚 Learn more

• Official website: https://www.phoenixframework.org/
• Guides: https://hexdocs.pm/phoenix/overview.html
• Docs: https://hexdocs.pm/phoenix
• Forum: https://elixirforum.com/c/phoenix-forum
• Source: https://github.com/phoenixframework/phoenix