Getting started

To get the project up and running locally follow these steps.

Prerequisites

• node v18.x

  node --version
  nvm use 18.17.0
  npm install -g npm@latest

• yarn

  yarn --version
  # or
  npm install --global yarn

Installation

1. Clone the repo

  git clone [email protected]:pixel-world/contests-renderer.git
  cd contests-renderer

2. Install NPM packages

rm -rf node_modules
  yarn install

3. Make sure to supply correct env variables You need the firebase getform and createsubmission urls

.env.example .env.local

Develop

yarn storybook

If error then run yarn upgrade yarn cache clean

Publish

yarn login yarn config list make sure logged into npm npm adduser username, email, password and OTP npm whoami

yarn publish

question New version: 0.0.xx (increment the version) question npm username:

Commit Message Format

type(scope): message

must be one of the following:

• feature: A new feature
• fix: A bug fix
• refactor: A code change that neither fixes a bug nor adds a feature
• perf: A code change that improves performance
• style: Changes that do not affect the meaning of the code (formatting, types, linting errors, etc.)
• test: Adding missing tests or correcting existing tests
• docs: Documentation only changes
• build: Changes that affect the build system or external dependencies (e.g. metro, webpack, yarn)
• ci: Changes to our CI configuration files and scripts (e.g. github actions, dependabot)

Scope (optional) Reflects a feature worked on. Typically used for large features that require multiple commits.

Message contains a succinct description of the change:

• use the imperative, present tense: "change", not "changed" or "changes"
• don't capitalize the first letter