Skip to content
/ react-template Public template

An opinionated react template including helpful libraries, end-to-end testing support and CI/CD pipelines

License

Notifications You must be signed in to change notification settings

bitroll-team/react-template

Repository files navigation

React template

How to use 🤔

  1. Create a new repository using this template. You can do this by clicking the "Use this template" button on the repository page or by clicking here.

  2. Clone your new repository.

  3. Install dependencies.

pnpm install
  1. Configure the environment variables. You can do this by copying the .env.example file to .env and filling in the values or by modifying the config/environment.ts defaults.

  2. Start the development server.

pnpm dev

Customization 🎨

Note that this template is meant to be customized. Here are some things you might want to change:

  • The name field in the package.json file.
  • The title and <meta> tags in the index.html file.
  • The favicons in the public/icons folder. You can use this generator to generate them from an image.
  • The github username and email in the integration.yaml file.
  • The environment variables in the Dockerfile to match your production environment. Note that this is needed because, as React is a client-side framework, the environment variables are embedded in the build.