This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.
This is an example of how to list things you need to use the software and how to install them.
- Install packages with pip
pip install -r requirements.txt
- Ensure that you have all the required credentials of the databases to run the code sucessfully
-
Clone the repository:
git clone https://github.com/cherylthy/database-project
-
Start to execute the code in the main.py folder after installing all required packages
Open a terminal or command prompt, navigate to the directory containing the main.py file, and execute the file using the Python interpreter.(venv) PS ...\database-project> python main.py
Should output as:
* Serving Flask app 'main' * Debug mode: on WARNING: This is a development server. Do not use it in a production deployment. Use a production WSGI server instead. * Running on http://localhost:5000 (will be localhost:8080 if run on mac) Press CTRL+C to quit * Restarting with watchdog (windowsapi) * Debugger is active! * Debugger PIN: 386-256-135
-
Click on http://localhost:5000 to access the webpage or copy the link into your desired browser.