https://github.com/certainlywrong/clientpulse
https://github.com/certainlywrong/clientpulse
Last synced: 7 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/certainlywrong/clientpulse
- Owner: certainlyWrong
- Created: 2023-12-08T17:57:20.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-02-23T03:51:45.000Z (almost 2 years ago)
- Last Synced: 2025-03-26T18:24:49.799Z (9 months ago)
- Language: Python
- Size: 12.7 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# About ClientPulse
This is a simple API for project [StockMingle](https://github.com/certainlyWrong/StockMingle). It is written in Python and uses the FastAPI framework to serve the API and MySQL as the database.
## How to run
To run this project separately, you need to have Docker installed on your machine. After that, you can run the following command to start the database:
```bash
docker run -p 3306:3306 --name clientpulse-bd -e MYSQL_ROOT_PASSWORD=123456 -e MYSQL_DATABASE=clientpulse
-d mysql:latest
```
After that, you can run the following command to start the API:
```bash
poetry run server
```
## Routes
You can see the routes in the following link: [http://localhost:8000/docs](http://localhost:8000/docs)