Giter VIP home page Giter VIP logo

recipe-app-api's Introduction

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(<scope>): 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 - [email protected]

recipe-app-api's People

Contributors

yuryalencar avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.