Joint Jam Website

Getting started

Requirements:

• Node.js
• PNPM

Steps:

1. Clone the repo.
2. Run pnpm install to install dependencies.
3. Run pnpm run dev to start the development server.

Development notes

Miscellaneous notes on less obvious or useful things about the repo.

• Absolute imports are used. These are imports prefixed by @website/.
• ESLint is automatically ran on save for VS Code. Other IDEs may have similar features.
• React Router v6 is installed. Make sure you're looking at the right docs.
• Tailwind CSS is installed.
• Typings are automatically generated for .css files.
• clsx can be used to split CSS class strings onto multiple lines and for conditional styling.

Folders

• public: Website assets. Directly copied to output
• src/assets: Website assets. Processed by bundler.
• src/components: Reusable components.
• src/data: Used to store static data and to reduce hardcoding.
• src/pages: Individual pages of the website.
• src/styles: Shared styles. CSS for specific components should be located next to the component.