Skip to content

Latest commit

 

History

History
42 lines (31 loc) · 1.7 KB

README.md

File metadata and controls

42 lines (31 loc) · 1.7 KB

Django Book API

Django Book API

Simple API using Django for creating books and authors

Requirements

  • Docker [version >=19.03.13]
  • Docker Compose [version >=1.27.4]
  • git [version >=2.9]

Installation

  1. Clone the repo
  2. Run docker compose build
  3. Next run docker compose up
  4. Access API on http://localhost:8000/

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

For this project we like to follow conventional commits

Summary of Conventional Commits

Conventional Commits is a specification for adding human and machine-readable meaning to commit messages. The key elements include:

  • feat: A new feature for the user.
  • fix: A bug fix for the user.
  • docs: Documentation only changes.
  • style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc).
  • refactor: A code change that neither fixes a bug nor adds a feature.
  • perf: A code change that improves performance.
  • test: Adding missing or correcting existing tests.
  • build: Changes that affect the build system or external dependencies.
  • ci: Changes to our CI configuration files and scripts.
  • chore: Other changes that don't modify src or test files.
  • revert: Reverts a previous commit.

For more details, visit the Conventional Commits website.

API Endpoints

For detailed information on the available API endpoints, please refer to the Endpoints documentation.