RPKM66

Frontend interface for the RubPuenKaoMai 2023 website.

Prerequisites

Please install the following.

• Node.js
• pnpm
• Git

Getting Started

1. Clone this repository

   git clone https://github.com/isd-sgcu/rpkm66-frontend.git

   or download the zip file and extract it.

   Note: Make sure you go into the directory after cloning or extracting the zip file.

   cd rpkm66-frontend

2. Install dependencies

   pnpm install

3. Run the development server

   pnpm dev

4. Open localhost:3000 in your browser. Done!

Contributing

1. Create a new branch

   git checkout -b <branch-name> origin/dev

   Note: Please copy the branch name from Linear and use it as the branch name.

2. Make your changes

3. Stage and commit your changes

   git add .
   
   git commit -m "<commit-message>"

   Note: Don't forget to use the conventional commit format for your commit message.

4. Push your changes

   git push origin <branch-name>

5. Create a pull request to the dev branch in GitHub

6. Wait for the code to be reviewed and merged

7. Repeat

   Note: Don't forget to always pull the latest changes from the dev branch before creating a new branch.

   git pull origin dev

If you have any questions, please contact us on Slack.

Enjoy! 😋

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.