🖥️Frontend

Quick Start Guide

Jump to

• Running Locally

• Prerequisites

• Environment Variables

• Deployment

Running Locally

Download and install Node.js (Version 10+), if you haven't already.

To run the project, fulfill all prerequisites and cd into the /frontend folder.

Create a .env file, at root-level, containing the requisite environment variables mentioned above.

Subsequently, install dependencies by running:

npm install

Start the app using:

npm start

Prerequisites

Setup and run the Backend API

You'll need access to a running instance of backend and the clerk perishable key generated while setting up the backend.

For details on setting up and running the backend, please refer to this guide:

⚙️Backend API

Environment Variables

Variable	Description	Purpose
REACT_APP_CLERK_PUBLISHABLE_KEY	API Key to authenticate with Clerk.	Auth
REACT_APP_BACKEND_URI	Base URL for backend API	Identify backend API deployment.

Deployment

Use any static site hosting service like Vercel, Cloudflare Pages or DigitalOcean App Platform to deploy the app by specifying the basic configuration details specified above and furnishing requisite environment variables.

The guides below detail this process:

• Vercel

• Cloudflare Pages

• DigitialOcean

Configuration Details

Property	Value	Addl. Details
Framework	React	Version 18.1.0
Build Command	npm run build	Node Version >=10
Build output directory	/build
Root directory	/frontend