InDev

Table of Contents

• Getting Started
  • Prerequisites
  • Installation
• Usage
  • Running with Docker
• Contributing
• License
• Swagger Documentation

Getting Started

Instructions for setting up and using your project locally.

Prerequisites

• Python 3.9 or later
• Docker (optional, for containerization)
• Postgres

Installation

1. Clone this repository to your local machine:

   https://github.com/Carti23/InDev.git
   cd InDev

Running with Docker

1. Build the Docker image from the project directory:

   docker-compose build 

2. Run the Docker container:

    docker-compose up

3. Make Migrations

     docker-compose run --rm web-app sh -c "python manage.py makemigrations"

Contributing

Contributions to this project are welcome. Follow these steps to contribute:

1. Fork the repository and clone your fork:

   git clone https://github.com/your-username/your-project.git
   cd your-project

2. Create a new branch for your changes:

   git checkout -b feature/new-feature

3. Make your changes, commit, and push to your fork:

   git add .
   git commit -m "Add new feature"
   git push origin feature/new-feature

4. Create a pull request describing your changes.

License

This project is licensed under the [Your License Name] - see the LICENSE file for details.

Swagger Documentation

Access the Swagger API documentation at http://localhost:8000/swagger/ for more details on the API endpoints and usage.