Project was developed on top of a challenge made on the elixir trail in rocketseat.
Before you begin, make sure you have met the following requirements:
- You need the latest version of
Elixir/Phoenix
andPostgreSQL
on your machine.
If you need installation instructions, click here.
To install Daily Meals, follow these steps:
1ΒΊ Clone the repository.
> git clone https://github.com/joabehenrique/daily-meals.git
2ΒΊ Open the project in your vscode and run the command
> mix deps.get
3ΒΊ Configure your postgresql in your profile
> config / dev & test
4ΒΊ Just run project
> mix phx.server
To use Daily Meals, follow these steps:
Project was developed on top of a challenge made on
the elixir trail in rocketseat.
In it you can create a new daily meal, remove,
update, fetch meals or a specific one.
Getting all meals
(GET) api/v1/meals
Getting a meal
(GET) api/v1/meals/{id}
Deleting a meal
(DELETE) api/v1/meals/{id}
Creating a meal
(POST) api/v1/meals
{
"description": "Pizza 1/2 Calabresa",
"date": "2022-03-21 13:14:22",
"calories": 236
}
Changing a meal
(PUT) api/v1/meals/{id}
{
"description": "Pizza 1/2 4 Queijos",
"calories": 102
}
Getting all users
(GET) api/v1/users
Getting a user
(GET) api/v1/users/{id}
Deleting a user
(DELETE) api/v1/users/{id}
Creating a user
(POST) api/v1/users
{
"name": "Joabe Henrique",
"email": "[email protected]",
"cpf": "12345678990"
}
Changing a user
(PUT) api/v1/users/{id}
{
"name": "Joabe Carvalho",
"email": "[email protected]",
}
To contribute to Daily Meals, follow these steps:
- Fork this repository.
- Create a branch:
git checkout -b <nome_branch>
. - Make your changes and commit them:
git commit -m '<commit_message>'
- Send to the original branch:
git push origin Daily Meals / <local>
- Create the pull request.
Alternatively, see the GitHub documentation at how to create a pull request..
We thank the following people who contributed to this project:
Joabe Henrique [Author] |
Do you want to be part of this project? Click here and read how to contribute.
This project is under license. See the license file for more details.