NUS-SoC-TIPS/frontend

A monolithic rewrite of Code2Gather for NUS SoC Technical Interview Preparation (Summer).

Frontend for TIPS

Overview

TIPS is a monolithic rewrite of Code2Gather to support the technical interview preparation for NUS SoC students. Its functionalities include:

• Collaborative Code Editor with Mock Interview Support
• LeetCode Question Tracking with Telegram Integration
• (WIP) Interview Roleplay with Partner Matching and Question Generation

Contributors

Code2Gather was originally developed by the following people for NUS CS3219:

• He XinYue
• Wang Luo
• Wen Junhua
• Zhu Hanming

Project Requirements

Node.js v14 LTS

One easy way to install Node is to simply download from their website.

Another alternative way is to utilise nodenv. Do check out their README.md for OS-specific installation instructions.

Yarn

Once you have Node installed, simply install Yarn using npm:

npm install --global yarn

We will be using Yarn for Node dependency management, as well as for its workspaces functionality, the latter of which will streamline some project-level processes, such as pre-commit checks.

Contributing to TIPS

Installation

First, clone this repository:

git clone https://github.com/CodeToGather/TIPS-Frontend.git

Then, navigate to the project root and install the dependencies:

cd TIPS-Frontend
yarn install && husky install

Finally, you can get the frontend up and running via:

yarn start

Backend

You can find the backend here.

Committing

Please read CONTRIBUTING.md for our commit guidelines.

The easiest way to start committing is to run the following command anywhere within the project directory:

yarn commit

You will be guided through an interactive prompt that will help you craft a beautiful commit message, using commitizen.