Git Product home page Git Product logo

django-bookstore-api's Introduction

django-bookstore-api

Django API for a Bookstore

Our project is called iris - the flower of knowledge

The project is based on the Gravity Bookstore Database, a fictional bookstore called “gravity” that captures information about books, customers, and sales.

How to start the project server?

Create virtual environment and activate it:

$ python -m venv .venv
$ source .venv/Scripts/activate

Install packages:

$ pip install -U -r requirements-local.txt
...

Run Django database migrations:

$ python iris/manage.py migrate

Start development server:

$ python iris/manage.py runserver
Watching for file changes with StatReloader
Performing system checks...

System check identified no issues (0 silenced).
September 17, 2023 - 23:30:38
Django version 4.2.5, using settings 'iris.settings_local'
Starting development server at http://127.0.0.1:8000/
Quit the server with CTRL-BREAK.

You can open a browser and naviage to http://127.0.0.1:8000/docs/ to explore the API through a Swagger interface.

How to build documentation?

Build database diagram

$ DJANGO_SETTINGS_MODULE=iris.settings_local python iris/manage.py graph_models -g -o docs/diagrams/database.png iris books customers orders

Build documentation

$ cd docs
$ make html
...

The documentaiton build output can be found under the {project_root}/docs/_build/html directory.

django-bookstore-api's People

Contributors

ivangeorgiev 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.