RevPloy API

Welcome to the RevPloy! This API provides resources for managing HR activities in a company.

Getting Started

To get started with the RevPloy, follow the instructions below to set up the project locally.

Clone the repository:

git clone https://github.com/ezeisraeljohn/revploy.git
cd revploy

Set up a virtual environment:

python -m venv .venv
source .venv/bin/activate  # On Windows use `.venv\Scripts\activate`

Install the dependencies:
```
pip install -r requirements.txt
```
Configure the database:

Ensure you have a PostgreSQL or MySQL database set up. Update the database settings in the config.database.py file.
```
DATABASE_URL = "postgresql://username:password@localhost/dbname"
```
you can ignore the connect_args.
Run the server:
```
uvicorn api.app:app --reload
```

Once the server is running, you can interact with the API using tools like Postman or curl.

You can test the API endpoints using Postman. Import the collection directly using the following link:

For detailed API documentation, visit the Postman endpoints.

This project is licensed under the MIT License. See the LICENSE file for details.