https://github.com/yuryalencar/recipe-app-api
Recipe API project develop using Django Rest Framework
https://github.com/yuryalencar/recipe-app-api
django django-rest-framework django4 docker docker-compose flake8 tdd tdd-python test-driven-development
Last synced: 8 months ago
JSON representation
Recipe API project develop using Django Rest Framework
- Host: GitHub
- URL: https://github.com/yuryalencar/recipe-app-api
- Owner: yuryalencar
- License: mit
- Created: 2023-06-27T21:55:05.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-07-03T14:11:50.000Z (over 2 years ago)
- Last Synced: 2025-01-04T20:51:57.706Z (9 months ago)
- Topics: django, django-rest-framework, django4, docker, docker-compose, flake8, tdd, tdd-python, test-driven-development
- Language: Python
- Homepage:
- Size: 64.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Recipe App API
Recipe API project develop using Django Rest Framework and Docker
## Installing
This project uses Docker, and all commands to use and install are run with Docker.
> build project
```
docker compose build
```
> run project
```
docker compose up
```
```
docker compose up -d
```
> stop project
```
docker compose down
```
ps.: To verify your application open 127.0.0.1:8000
## Verifying the code patterns
> to run flake8
```
docker compose run --rm app sh -c "flake8"
```
## Run unit tests
> to run tests
```
docker compose run --rm app sh -c "python manage.py test"
```
## Django commands
> to create a new Django project
```
docker compose run --rm app sh -c "django-admin startproject app ."
```
> to create migrations
```
docker compose run --rm app sh -c "python manage.py makemigrations"
```
> to run migrations
```
docker compose run --rm app sh -c "python manage.py migrate"
```
## Contributing
Contributions are what make the open source community an incredible place to learn, inspire and create. Any contribution you make will be **much appreciated**.
1. Make a project Fork
2. Create a Branch for your feature (`git checkout -b feature/amazing-feature`)
3. Insert your changes (`git add .`)
4. Make a commit with your changes (`git commit -m 'feat(): Inserting a Amazing Feature !`)
5. Push the branch (`git push origin feature/amazing-feature`)
6. Open a Pull Request
## License
Distributed under the MIT license. See `LICENSE` for more information.
## Contact
Yury Alencar - [Github](https://github.com/yuryalencar) - **yuryalencar19@gmail.com**