https://github.com/ezeisraeljohn/revploy
This API handles Employee Management in a Cooperation
https://github.com/ezeisraeljohn/revploy
aiven employee-management fastapi mysql python
Last synced: 3 months ago
JSON representation
This API handles Employee Management in a Cooperation
- Host: GitHub
- URL: https://github.com/ezeisraeljohn/revploy
- Owner: ezeisraeljohn
- Created: 2024-08-25T17:20:57.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-29T04:16:01.000Z (almost 2 years ago)
- Last Synced: 2025-03-01T03:26:06.452Z (over 1 year ago)
- Topics: aiven, employee-management, fastapi, mysql, python
- Language: Python
- Homepage: https://revploy.vercel.app
- Size: 164 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# RevPloy API
Welcome to the RevPloy! This API provides resources for managing HR activities in a company.
## Table of Contents
1. [Getting Started](#getting-started)
2. [Installation](#installation)
3. [Usage](#usage)
4. [Testing](#testing)
5. [API Documentation](#api-documentation)
6. [License](#license)
## Getting Started
To get started with the RevPloy, follow the instructions below to set up the project locally.
## Installation
1. **Clone the repository:**
```bash
git clone https://github.com/ezeisraeljohn/revploy.git
cd revploy
```
2. **Set up a virtual environment:**
```bash
python -m venv .venv
source .venv/bin/activate # On Windows use `.venv\Scripts\activate`
```
3. **Install the dependencies:**
```bash
pip install -r requirements.txt
```
4. **Configure the database:**
Ensure you have a PostgreSQL or MySQL database set up. Update the database settings in the `config.database.py` file.
```python
DATABASE_URL = "postgresql://username:password@localhost/dbname"
```
you can ignore the connect_args.
5. **Run the server:**
```bash
uvicorn api.app:app --reload
```
## Usage
Once the server is running, you can interact with the API using tools like [Postman](https://www.postman.com/) or [curl](https://curl.se/).
## Testing
You can test the API endpoints using Postman. Import the collection directly using the following link:
[
](https://documenter.getpostman.com/view/34635068/2sAXjJ6DG6)
## API Documentation
For detailed API documentation, visit the [Postman](https://documenter.getpostman.com/view/34635068/2sAXjJ6DG6) endpoints.
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.