https://github.com/zeyadomran/olympia
We built an all-in-one solution that allows gyms to manage their branches, services, equipment, and clients! We decided to call our project Olympia.
https://github.com/zeyadomran/olympia
flask next python react tailwindcss typescript
Last synced: 3 months ago
JSON representation
We built an all-in-one solution that allows gyms to manage their branches, services, equipment, and clients! We decided to call our project Olympia.
- Host: GitHub
- URL: https://github.com/zeyadomran/olympia
- Owner: zeyadomran
- Created: 2022-03-08T22:58:08.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-04-12T22:38:11.000Z (about 4 years ago)
- Last Synced: 2024-12-29T14:38:30.706Z (over 1 year ago)
- Topics: flask, next, python, react, tailwindcss, typescript
- Language: Python
- Homepage:
- Size: 500 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Olympia
### By: Zeyad Omran, Austin Shawaga, Nick Zhao
We built an all-in-one solution that allows gyms to manage their branches, services, equipment, and clients! We decided to call our project Olympia.
## The Front-End:
### To get started
- Download and install [node.js](https://nodejs.org/en/) (We're using v16.14.0).
### To Run
- cd into the `/web` directory
- run `npm install`
- make a file called `.env.local` in `/web` and add this line to it `NEXT_PUBLIC_BASE_URL="http://localhost:5000"` !important
- run `npm run dev`
- goto [http://localhost:3000/](http://localhost:3000/)
## The Back-End (API):
### To get started
- Download and install [python](https://www.python.org/downloads/)
- Install Necessary External Libraries using pip:
- Flask
- flask-cors
- app
- flask-mysql
- PyMySQL
- pyjwt
- bcrypt
- Ensure the host and password matches your MySQL server in the config.py file.
### To run
- Simply run main.py from //BackEnd/API/
- Note: The API runs on localhost port 5000 by default
## The Database:
### To get started
- Download and Install MySQL and MySQL-workbench (https://dev.mysql.com/downloads/)
- You need MySQL(Server,Shell,Router,Workbench) and Connector/Python
- Perform the necessary steps to launch a local MySQL server on your machine
- Import our Database from the //Backend/Dumps directory [LATEST_DUMP_11_04_2022.sql]
- You can do this by clicking Server -> Data Import -> from Self-Contained file
### To run
- Simply ensure that the server is running on a local port (dependant on OS).
- Windows uses a service model, so ensure the service is running.