TUK-lab-management-system

Main repository for tuk lab equipment allocation system

Requirements

1. Python 3.6+ installed
2. Django
3. Text editor such as vs code or sublime text
4. Git - preferrably use terminal like gitbash

Setup

1. Clone the repository.
2. Change directory to the location of this repository.
3. Create a .env file using the included .env.example as an example.
4. Generate a secret key for your app and paste into the SECRET_KEY section of .env file you can find generate the key from here
5. Create and start your preferred Python virtual environment. Install the required libraries.

pip install -r requirements.txt

6. After installation cd into the project path and run the following commands:

   python manage.py migrate

7. A local dbsqlite file will be generate at the root of the project.

8. Create a superuser by running the python manage.py createsuperuser and fill in the details.

9. After run python manage.py runserver open the browser and run localhost:8000 , login with the credentials created.

10. For details of how to get started with django, check out this link

11. In order to work with a virtual environment, check out this link

Usage

To run locally:

python manage.py runserver

Development

Pull the latest master version:

git pull origin master

Create local development branch and switch to it:

git branch dev
git checkout dev

Make desired changes then commit the branch.

git add .
git commit -m "changes to dev branch"
git push origin dev