https://github.com/certainlywrong/stockpulse
https://github.com/certainlywrong/stockpulse
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/certainlywrong/stockpulse
- Owner: certainlyWrong
- Created: 2023-11-27T08:00:24.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-02-23T03:52:06.000Z (over 1 year ago)
- Last Synced: 2025-01-31T23:44:47.206Z (4 months ago)
- Language: Python
- Size: 20.5 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# About Stockpulse
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 stockpulse-bd -e MYSQL_ROOT_PASSWORD=123456 -e MYSQL_DATABASE=stockpulse
-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)