Welcome to the kidlink backend! This project is a web API built with FastAPI. It is used to make prediction of message classification and provide mail service.
- Python 3.7+
- pip (Python package installer)
- ubuntu os
-
Clone the repository:
git clone https://github.com/kidlink-bangkit/kidlink-be.git cd kidlink-be -
Create and activate a virtual environment:
python3 -m venv env source env/bin/activate -
Install the dependencies:
pip install -r requirements.txt
-
Start the FastAPI server:
uvicorn main:app --reload
By default, the server will run on
http://127.0.0.1:8000.
FastAPI provides interactive API documentation:
- Swagger UI: Accessible at
http://127.0.0.1:8000/docs - ReDoc: Accessible at
http://127.0.0.1:8000/redoc