https://github.com/02loveslollipop/piarpis_api
A simmple API for PIARPIS project
https://github.com/02loveslollipop/piarpis_api
api-rest flask mongodb python
Last synced: about 2 months ago
JSON representation
A simmple API for PIARPIS project
- Host: GitHub
- URL: https://github.com/02loveslollipop/piarpis_api
- Owner: 02loveslollipop
- Created: 2024-04-07T05:19:45.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-05T00:21:44.000Z (about 2 years ago)
- Last Synced: 2025-01-23T08:43:54.328Z (over 1 year ago)
- Topics: api-rest, flask, mongodb, python
- Language: Python
- Homepage:
- Size: 6.28 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# PIARPIS API
> A python API to exchange data between JS frontend and DB.
## PIARPIS API
This repository is part of the PIARPIS project, the remaining repositories are listed below:
## Installation
To setup this repository you need to have python 3.10+ installed in your machine, then you can install the dependencies with the following command:
1. Clone the repository
```bash
git clone https://github.com/02loveslollipop/PIARPIS_API.git
```
2. Create a python 3.10 or later environment using Conda (**Optional**)
```bash
conda create -n python=3.11
```
3. Install the dependencies
```bash
pip install -r requirements.txt
```
4. copy the example_config.yaml file and rename it to config.yaml
```bash
cp example_config.yaml config.yaml
```
5. Edit the config.yaml file with your Configuration
6. Run the API
```bash
python api.py
```
## Note
This API is not intended to be used in production, it is only for testing purposes.
As the API is intended to be used in a local network, it does not have any security measures, so it is not recommended to use it in a public network.
## License
[MIT](https://choosealicense.com/licenses/mit/)