Skip to content

Latest commit

 

History

History
42 lines (25 loc) · 1.37 KB

README.md

File metadata and controls

42 lines (25 loc) · 1.37 KB
Raw

InstruGo App Frontend

Technologies

This is a Next.js project bootstrapped with create-next-app using Yarn package manager.

NOTE

This repository contains just the frontend for InstruGo. To see details about running the backend locally, go to the backend repository and read the README.md.

Prerequisites

You will need Node.js >= 16 and yarn installed on your machine.

Install dependencies

$ yarn

Run the app

# development mode
$ yarn dev

# production mode
$ yarn build
$ yarn start

IMPORTANT: If you're running the app in production mode, make sure to change the publicRuntimeConfig.apiUrl variable from https://api.instrugo.frle.net/api to http://localhost:8000/api in next.config.js file. Otherwise you will be sending requests to our deployed production backend which will be no good (it won't work for you). :)

Type checking and formatting

This project uses TypeScript, Prettier formatter and ESLint for best developing experience.

Combination of Husky and lint-staged is used for precommit insurance.

Deployment

This app is currently deployed via Vercel Platform.