9 lines
682 B
Markdown
9 lines
682 B
Markdown
# GETTING STARTED
|
|
#### Clone the repo with either `git clone https://git.fstropii.com/tropii/Venture_Of_Heros` or just by downloading the .ZIP file.
|
|
#### Create a virtual environment with `python -m venv venv` and activate it with `.\venv\Scripts\activate` on Windows or `source venv/bin/activate` on MacOS/Linux.
|
|
#### Install the required packages with `pip install -r requirements.txt`.
|
|
#### Run the API with `uvicorn main:app --reload` and run the main app with `python main.py`.
|
|
#### The API will be running on `http://127.0.0.1:8000` if that port is available.
|
|
#### To see all endpoints go to `http://127.0.0.1:8000/docs`
|
|
|
|
## Check the CHANGELOG for info on the latest updates. |