Skip to content

Latest commit

 

History

History
66 lines (40 loc) · 1.46 KB

README.md

File metadata and controls

66 lines (40 loc) · 1.46 KB

Programming Languages Forum Frontend

This project uses the Vite template for React with TypeScript.

Before you get started, you'll need to have Node.js (v20.12.1) installed and you'll need to enable corepack:

corepack enable

After that, you can install packages using

yarn install

Development Server

You can run the development server locally using:

yarn dev

Docker

You can find the Dockerfiles as Dockerfile and Dockerfile.dev respectively. Please refer to the main README for more information on the Docker setup.

Linting and Formatting

We use Prettier and ESLint for these purposes. You can run them using:

yarn lint
yarn format

Tests

We use Vitest for testing. It's a library similar to Jest that uses Vite in its backend. This allows consistency across true build environments and the test environment.

Start the test runner in watching mode using:

yarn test

Run tests once:

yarn test run

Hooks

We have husky and lint-staged set up such that all staged files are linted and formatted and tests are run before committing.

You can skip these checks using --no-verify (NOT RECOMMENDED).

Code

We use React Router, TailwindCSS, and shadcn-ui.

Components

We use shadcn's shadcn-ui component library. It will add components to our source which we can customize for our own use. Refer to the docs for more information.