NUS-CLASS-CONNECT

Welcome to nus-class-connect! This repository contains the frontend part for the website.

Getting Started

If you're a first-time user, follow these steps to get started:

Prerequisites

Make sure you have the following installed:

• [Your preferred IDE]
• [Git]

Installation

1. Open your IDE's terminal and navigate to a suitable folder. Then, run the following command to clone the repository:

git clone https://github.com/PallonCX/nus-class-connect.git

2. After cloning, navigate into the project directory using the following commands:

cd nus-class-connect

Making Changes

Before making change

1. Pull changes from the main repository and automatically merge them into your local branch.

git checkout main
git pull 

2. Create a new branch for your changes (modify the branch name to something suit your case, e.g. "navigation-bar-branch"):

git checkout -b my-feature-branch

3. Run the following command to start the development server. This will launch your React application, and you can view it in your web browser at http://localhost:3000.

npm run start

After making change

1. Stage your changes, and commit.

git add .
git commit -m "Description of changes"

2. Pull changes from the main repository and automatically merge them into your local branch.

git checkout main
git pull 

3. Merge your changes to the latest main branch:

git checkout my-feature-branch
git rebase main

4. Build the website.

npm run build

5. Stage your changes, and commit (for the build).

git add .
git commit -m "Description of changes"

6. Push your changes to GitHub.

git push --set-upstream origin my-feature-branch

7. Go to the repository on GitHub and click "Pull requests" at navigation bar.

8. Click the "New Pull Request" button.

9. Choose your branch name and click "Create Pull Request."

Folders / Files Explanation

1. src (folder)

   • Codes for the website.

2. index.html (file)

   • Must be placed at root in order for github to detect and render the website.