Pre-requisites
To be able to start development on Zenn, make sure that you have the following prerequisites installed:
- Required Node.js version: [14.23.1]
- Required Docker version: [26.0.0]
- Required Git version: [2.31.1]
To use local backend with this application, follow these instructions:
-
Clone the Repository:
git clone <repository-url>
-
Instal dependencies:
npm install
Husky Setup: Husky will be installed automatically along with the other dependencies. Husky helps to set up Git hooks easily in your project.
This project uses environment variables to manage configurations. Follow these steps to set up your environment:
- Create
.env
file:
touch .env
- Copy
.env.dist
to.env
cp .env.dist .env
- Update Environment Variables:
Open the .env
file and update the variables according to your environment.
Run npm run start
for a dev server. Navigate to http://localhost:`{ PORT }`/. The app will automatically reload if you change any of the source files.
Run npm run build
to build the project. The build artifacts will be stored in the dist/ directory. By default build the application with --prod
flag.
This project uses Cypress
for end-to-end testing. To run the tests use:
-
Run tests with with UI up
npm run e2e
-
Run tests only with the console
npm run test:ui