ttg-client

Contributing

See CONTRIBUTING.md

Prerequisites

• nvm or fnm
• Node.js v20.x 'Iron' (LTS)
• Git
• Visual Studio Code

Setup

You will need to provide the following environment variables:

• NEXT_PUBLIC_AWS_COGNITO_POOL_ID: Your Amazon Cognito User Pool ID
• NEXT_PUBLIC_AWS_COGNITO_CLIENT_ID: Your Amazon Cognito App Client ID
• NEXT_PUBLIC_COGNITO_DOMAIN: Your Amazon Cognito Managed Login domain
• NEXT_PUBLIC_OAUTH_SIGN_IN_REDIRECT_URL: Your app's sign in redirect URL as configured in Amazon Cognito
• NEXT_PUBLIC_OAUTH_SIGN_OUT_REDIRECT_URL: Your app's sign out redirect URL as configured in Amazon Cognito
• NEXT_PUBLIC_AWS_REGION: Your Amazon Cognito User Pool's region
• NEXT_PUBLIC_API_URL: Your ttg-server deployment URL

1. Clone the project to your workspace.

   git clone <url> ttg-client
   cd ttg-client

2. Create a .env file with development presets. Then enter your own environment variables from the links above.

   cp .env.example .env

3. Install and use the project's supported Node.js version.

   With nvm:

   nvm install

   With fnm:

   fnm install

4. Install dependencies.

   npm install

5. Build the website.

   npm run build

6. Serve the website on localhost:3000.

   npm run serve

Solution Stack

• 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