tropii/Venture_Of_Heros
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Implement a changelog and readme

Browse Source
This commit is contained in:
TropiiDev 2025-02-25 20:02:16 -05:00
parent 7aa88e11af
commit c4217c5132
2 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
CHANGELOG.md Normal file
View File

@ -0,0 +1,9 @@
## CHANGELOG
## VER: Alpha #7
## What's new?
- Updated the file structure to hold all the FastAPI files in its own dedicated 'api' folder
- Updated the 'main.py' file to have a working login and register feature
- Updated the 'sql.py' file to have a 'VerifyHero' model for verifying the hero's email & password
- Added a 'functions.py' file to hold all the functions for the main app. (The functions.py file for the API is in the 'api' folder)
- Added CHANGELOG and README files to the project

9
README.md Normal file
View File

@ -0,0 +1,9 @@
# 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.