HKU-Hackathon-2023/Hackathon-gp14

Project Name

A brief description of the project goes here.

Table of Contents

• Project Name
• Table of Contents
• Project Description
• Features
• Follow the following steps
  • Set Up Auth GitHub locally (Execute the following commands on your terminal)
  • Installing required package
• Usage
• Contributing
• License
• Notion:

Project Description

Features

Follow the following steps

Set Up Auth GitHub locally (Execute the following commands on your terminal)

1. Install required package.

   (Mac OS) brew install gh
   

   (Window) winget install --id GitHub.cli
   

2. Start auth process.

   gh auth login
   

3. Pick the following accordingly
4. Copy the one-time code shown on your terminal
5. Press enter to open the browswer
6. Click the green button
7. Done. Try clone the repo by executing to check

git clone https://github.com/HKU-Hackathon-2023/Hackathon-gp14.git

Installing required package

1. Start virtual environment (Run on terminal)

   python3.11 -m venv .vene
   

2. Activate virtual environment (Run on terminal)

   source .vene/bin/activate
   

3. Install required package (Run on terminal)

   pip install -r requirements.txt
   

4. To exit the virtual environment

   deactive
   

Usage

Contributing

License

Specify the license under which the project is distributed. Mention any restrictions or permissions granted by the license. Contact Information Optionally, you can provide contact information for users to reach out to you in case they have questions or need support.

Notion:

STEP

Features & functions

• Design Quizs and Assignments
• Customize response base on background and education level
• further questions and topics
• progress tracking
• Book Mark
• Recap
• Notes (Notes making)
• Daily Challenge & Awards