larngear festival 2024

website for larngear festival 2024

Prerequisites

Please install the following.

• Node.js
• pnpm
• Git

This project use Nextjs and TailwindCSS as CSS Framework.

Getting Started

1. Clone this repository

# Using SSH (recommended)
git clone git@github.com:isd-sgcu/larngear-festival-2024/larngear-festival-2024.git

# Using Https (not recommended)
git clone https://github.com/larngear-festival-2024/larngear-festival-2024.git

2. Go to project folder

cd larngear-festival-2024

3. Install all dependencies

pnpm install

4. Run

pnpm dev

5. Go to http://localhost:3000 in your fav browser.

Contributing

We will seperate a branch for each features, create pull request for combine code together.

1. Go to main branch and pull updated code

git checkout main

git pull

2. Create branch and go to your branch

git branch {your_branch_name}

git checkout {your_branch_name}

Note : exmaple of {your_branch_name} is feat/border-component, feat/timer

3. Push your branch upstream

git push --set-upstream origin {your_branch_name}

4. Working with your code

5. Stage and commit your changes

git add .

git commit -m {commit_message}

6. Push your code in to your branch

git push

7. Create pull request to main branch in github
8. Wait for the code to be reviewed and merged

Conventional Commit Format

In short, the commit message should look like this:

git commit -m "feat: <what-you-did>"

# or

git commit -m "fix: <what-you-fixed>"

# or

git commit -m "refactor: <what-you-refactored>"

The commit message should start with one of the following types:

• feat: A new feature
• fix: A bug fix
• refactor: A code change that neither fixes a bug nor adds a feature
• style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)

For more information, please read the conventional commit format documentation.