DIS Service

Table of Contents

• Introduction
• Forking the Repository
• Cloning the Repository
• Setting Up the Environment
• Installing Dependencies
• Running the Application
• Running Tests
• Contributing

Introduction

This project is a FastAPI-based service for managing user registrations and logins. It uses Pydantic for data validation and MongoDB for data storage.

Forking the Repository

1. Go to the repository.
2. Click the Fork button in the top-right corner of the page.
3. Select your GitHub account to fork the repository.

Cloning the Repository

1. Open your terminal.
2. Clone the forked repository to your local machine:

   git clone https://github.com/<your-username>/dis_service.git

3. Navigate to the project directory:

   cd dis_service

Setting Up the Environment

1. Create a virtual environment:

   python -m venv .venv

2. Activate the virtual environment:
   • On Windows:

     .venv\Scripts\activate

   • On macOS/Linux:

     source .venv/bin/activate

Installing Dependencies

1. Install the required dependencies:

   pip install -r requirements.txt

Running the Application

1. Start the FastAPI application:

   uvicorn app.main:app --reload

2. Open your browser and navigate to http://127.0.0.1:8000/docs to access the API documentation.

Running Tests

1. Run the tests using pytest:

   pytest

Contributing

1. Create a new branch for your feature or bugfix:

   git checkout -b feature/your-feature-name

2. Make your changes and commit them:

   git commit -m "Add your commit message"

3. Push your changes to your forked repository:

   git push origin feature/your-feature-name

4. Create a pull request from your forked repository to the main repository.