student-intern-organiser

This is a way for WEHI to organise the Research Software Engineer Student Internship program

Installation

To begin, please follow the steps below for installing Python and setting up the virtual environment:

Install Python

Download the latest version of Python from the official website. Download Here

Windows

Follow the installation instructions provided, ensuring that Python is added to the system PATH.

Install virtualenv

Open the command prompt. Run the following command to install virtualenv:

pip install virtualenv

Create a virtual environment

Open the command prompt in the desired project directory/folder. Create a new virtual environment by running the following command:

virtualenv .env

Activate the virtual environment

Run the following command to activate the virtual environment:

.\.env\Scripts\activate

Run the application

This line will refresh the server every time a new save is made

flask --app app.py --debug run

Regular line to run flask

flask run

If you want to run flask on a different port

flask run -h localhost -p 5001

MacOS/Linux

Open Terminal

install virtualenv

pip install virtualenv

Create a virtual environment

python3 -m venv venv

Activate the virtual environment

source venv/bin/activate

Install Flask

pip install flask

Make sure the virtual environment is activated.

Run the Flask application

This line will refresh the server every time a new save is made

flask --app app.py --debug run

Regular line to run flask

flask run

If you want to run flask on a different port

flask run -h localhost -p 5001

Setup of the database

Please use student_intern_data_public to setup the database to use flask run

Note: Remember to deactivate the virtual environment once you have finished using the application. Simply run the command

deactivate

in the terminal to deactivate the virtual environment.

We hope this documentation helps you in setting up and running the Student Intern Organiser effectively.

If you have any further questions or issues, please don't hesitate to reach out for assistance.