Skip to content

README.md

Latest commit

 

History

History
31 lines (27 loc) · 1.03 KB

README.md

File metadata and controls

31 lines (27 loc) · 1.03 KB

The NC Doughnuts API

This API concerns sales of yummy doughnuts from the Northcoders bakery.

The code should be deployable in any Unix-like OS. The build process outlined below requires Python be installed along with GNU Make. MacOS users can get access to the make command via Homebrew or MacOS Command Line Tools.

To run the API locally:

  1. Fork and clone the repo.
  2. Ensure that your Python interpreter is Python at least 3.11.x - you may use a tool like pyenv.
  3. In the root of the project, create the run environment with: 
    make requirements
  4. Set up the required dev tools: 
    make dev-setup
  5. Run the tests. 
    make run-checks
  6. Start the server by running: 
    make start-server
  7. In your browser, navigate to localhost:8000/docs/ to view the API documentation page.
  8. Then you can navigate to the endpoint of your choice, e.g. localhost:8000/api/doughnuts.

API logs are available in logs/app.log.