diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..368f70c --- /dev/null +++ b/CHANGELOG.md @@ -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 \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..8ca921b --- /dev/null +++ b/README.md @@ -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. \ No newline at end of file