ttg-client

Prerequisites

• NVM
• Node.js v20.x 'Iron' (LTS)
• Git
• Visual Studio Code

Setup

• git clone <url>: Clone the project to your workspace

• nvm install: Install and use the correct version of node for the project

• npm i: Install required packages using npm

• Enable these VSCode extensions in the project workspace:

  • Code Spell Checker
  • ESLint
  • Prettier

Running

Run On Host Machine

See Scripts > Running below.

Scripts

These scripts are located in package.json and can be run using npm run <script>.

Running

• dev: Starts Next.js in development mode.
• build: Builds the application for production usage and outputs the generated static site to out/.
• serve: Serves the built static files from out/.

Linting & Formatting

• lint: Run Next.js's built-in ESLint configuration.
• prettier: Runs Prettier to format all files in the project directory.

Workflow

Please follow the GitHub flow for contributions:

1. Update your local main branch

   Switch to your main branch and pull the latest changes from the remote repository:

   git switch main
   git pull --prune

   • The --prune option removes any references to branches that no longer exist on the remote.

2. Create a new branch

   Name your branch following the convention issue-number (e.g., issue-1):

   git switch -c <issue-number> main

   • If no issue exists for the change you are making, please create one.

3. Make your changes

   Start the development server:

   npm run dev

4. Test your changes

   Run the following checks to ensure everything works as expected:

   npm run lint
   npm run build
   npm start:static

5. Review your changes

   Check which files have been changed:

   git status

6. Stage your changes

   Add the relevant files to staging:

   git add <files>

7. Commit your changes

   Write a meaningful commit message:

   git commit -m "<commit message>"

8. Push your branch

   Push your changes and set the upstream branch:

   git push -u origin <your-branch-name>

9. Create a pull request

   Create a pull request on GitHub. Fill in the template and link it to the issue using:

   Fixes #[issue number]

Documentation

• Language: JavaScript
• Framework: Next.js
• Styling: TailwindCSS
• Authentication: react-oidc-context
• Runtime: Node.js
• Package Manager: npm
• Version Control System:
  • Git
  • GitHub
• CI/CD: GitHub Actions
• Linting: ESLint
• Formatting: Prettier
• Git Hooks:
  • Husky
  • lint-staged