Tofuwuuu/Final_Project

Consultation Program

Consultation System for Teachers

A final project titled Consultation Scheduling System for DCIT25 and DCIT55.

See Table of contents for references.

Table of contents

• 1. Starting Guide
  • 1.1 How to fork; Not the utentils
  • 1.2 IDE of Choice
  • 1.3 Using python virtual environment
  • 1.4 Requirements
  • 1.5 User Interface Designer
• 2. Contributing

Installation Guide

How to fork

You can choose to fork the project to your local repo using:

1. the download link from the github repository: Code > Download Zip or Click here to download;
2. a terminal, have git installed.

   git clone https://github.com/Tofuwuuu/Final_Project
   

3. the fork button in github repo.

   Not recommended as you need to do a pull request everytime you push new implementation.

You decide where to work on the project

It can be PyCharm, VSCode, Visual Studio, or notepad. Albeit recommended to use PyCharm because of our course IDE of choice.

Should you use Python VENV?

Python Virtual environment allows you isolate the project dependencies from python libraries installed in your computer. What goes in the VENV stays in the VENV.

Proceed to requirement installation if you don't want to use a python virtual environment.

Check your python module if you have already installed the virtualenv. Go to any terminal and type pip list to list down all your computer modules. Do a pip install virtualenv if you see no virtualenv.

Change your directory to your local repository and initialize a virtual env:

python -m venv <name of your venv>

To activate virtual env

windows: source <name of your venv>/Scripts/Activate
macOS: source <name of your venv>/bin/activate

Requirements

Once you have a local repository, run requirements.txt using this line of code in your Git terminal:

pip install -r requirements.txt

This should install all the project dependencies and their respective versions.

Contributing

What's next? See CONTRIBUTING.md for detailed development execution.