Pastel Explorer Website (Frontend)
Project Root
├── "configuration-files"
│
├── public
│ └── static
│
└── src
├── components
│ └── pascal-case-component-name
│ ├── PascalCaseComponent.tsx
| └── PascalCaseComponent.styles.ts
│
└── pages
└── pascal-case-page-name
├── PascalCasePage.tsx
├── PascalCasePage.helpers.tsx
└── PascalCasePage.styles.ts
- Use PascalCase to name React Components (put them into
src/components/
structure), andexport default
an unnamed component - Use PascalCase to
name the pages (put them into
src/pages/
structure) - Use camelCase to name variables, constants, functions, and methods
- Use PascalCase to name classes
- Use a single underscore in front of a method name to indicate private (non-public) methods
Make dot env file from the example one.
cp .env.example .env
Run the app in the development mode.
yarn start
Make sure you use the proper env variables when building the app in the CI/CD pipeline.
To run the type check and unit tests, use the following command:
yarn test