- Node.JS 18 [Download Here]
- Typescript 5.2 [Instructions to Download]
| command | description |
|---|---|
yarn install / yarn |
install dependencies |
yarn start |
start dev server |
yarn build |
build project |
yarn lint |
lint files (eslint + stylelint) |
yarn rsc [release-version] |
Lints release/release candidate version |
.env-development and .env-production is the custom solution for CI, which is used to build the app for different environments e.g. staging and production in github workflow files.
Before start development or manual deploy app with dist dir - make sure you have copied .env-[environment] file in to .env.[environment] file, where [environment] is the name of the environment, e.g. .env-production or .env-staging and fulfill it with your own values.
cp .env-development .env.development
# or
cp .env-production .env.production docker build --no-cache --progress=plain --build-arg BUILD_VERSION=1.0.0-rc.0 -t react-template .docker-compose config works with .env file only, so make sure you have it
docker run -d -p 80:80 --name [container-name] [image-name]
.env-development and .end-production is a files, which are used to run build in github workflow files, e.g. here at line 32
It sets the environment variables for the vitejs build, which are called in werf.yaml file yarn start command.
After that, docker image could be used to deploy the app
If you want to build app locally, you can copy .env-production files and fulfill it with your own values, then run command yarn build or .env-development for yarn start command
Env variables can be rewritten by [env.is] (./static/env.js) file in runtime. To do so, we need to provide same env variables there in json format
We welcome contributions from the community! To contribute to this project, follow these steps:
- Fork the repository.
- Create a new branch with a descriptive name for your feature or bug fix.
- Make your changes and commit them.
- Push your changes to your branch on your GitHub fork.
- Create a pull request from your branch to the
mainbranch of this repository.
Please ensure your pull request adheres to the following guidelines:
- Add a clear pull request title;
- Add a comprehensive pull request description that includes the motivation behind the changes, steps needed to test them, etc;
- Update the CHANGELOG.md accordingly;
- Keep the codebase clean and well-documented;
- Make sure your code is properly tested;
- Reference any related issues in your pull request;
The maintainers will review your pull request and may request changes or provide feedback before merging. We appreciate your contributions!
For the changelog, see CHANGELOG.md.
This project is under the MIT License — see the LICENSE file for details.