Skip to main content

Project Setup

Installing Dependencies​

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.0/install.sh | bash

nvm install
nvm alias default 20
nvm use

npm install

Configuration Files​

You can modify or add extra scripts in the package.json file. Below are some pre-configured script commands:

Debug the Project​

🚀 Start the project in debug mode using the command below 🚀:

npm start

The application will run at: localhost:8000

Check Code Formatting​

npm run lint

Check and Auto-Fix Code Formatting​

npm run lint:fix

Run Tests​

npm test

Build the Project​

npm run build

Automatic Deployment​

The project's .github/workflows/build.yml file is configured with an automatic deployment workflow based on version tags. Simply create a tag that follows the format ‘v*’ locally and push it to the remote repository to trigger a deployment. By configuring the keys CLOUDFLARE_API_TOKEN and CLOUDFLARE_ACCOUNT_ID in the project, automatic deployment to Cloudflare Pages is enabled.

# List existing tags
git tag

# Create a new tag
git tag v0.0.1

# Push the tag to the remote repository
git push origin v0.0.1