Skip to content

Latest commit

 

History

History
82 lines (55 loc) · 1.4 KB

INSTALATION.md

File metadata and controls

82 lines (55 loc) · 1.4 KB

How to Setup

Prerequisites

  • Node.js and npm (or yarn/pnpm) Download
    • Node --version: >=20
    • Use (Node Version Manager (nvm) to manage the version of node.
    • After installing nvm install v20 of node, that will install node v20 along with supported npm version.
      nvm install 20

Setup Instructions

  1. Clone the repository:

    git clone https://github.com/avantifellows/quiz-creator.git
  2. Install dependencies:

    cd quiz-creator
    nvm use 20
    npm ci
  3. Set up environment variables:

    Create a .env.local file and add the required variables values

    cp .env.example .env.local

Run Local Server

  1. Start the development environment:

    npm run dev
  2. Access the application:

    The application should be accessible at http://localhost:3000.

Run Production Server

  1. Build the application:

    npm run build
  2. Start the Server:

    npm run start

Other Useful Scripts

  1. Linting & Formating:

    npm run lint:fix
    npm run format
  2. Unit Testing:

    npm run test:jest
  3. E2E Testing:

    npm run test:cypress