Skip to content

Latest commit

 

History

History
113 lines (70 loc) · 2.03 KB

SETUP.md

File metadata and controls

113 lines (70 loc) · 2.03 KB
Raw

Setup Guide

This guide will help you setup Sunaar on your local machine.

Instructions

Node.js (Frontend)

Golang (Backend)

Clone the repository

  • Clone the repository
git clone https://github.com/TechAtikiN/sunaar

Set up the environment variables

Frontend
  • Navigate to the /client directory
cd client

  • Rename the .env.example file to .env.local file in the client directory

  • Fill in with the relevant environment variables

Backend
  • Navigate to the /server directory
cd server

  • Rename the .env.example file to app.env file in the server directory

  • Fill in with the relevant environment variables

Running Frontend

  • Install pnpm (Package Manager)

You can use npm or yarn as well, but I have used pnpm

npm install -g pnpm
  • Install dependencies
cd client
pnpm install
  • Run the development server
pnpm dev
  • Open the browser and go to http://localhost:3000

If you encounter a browser error, it will be resolved upon starting the backend server.

Kindly refresh the page once the backend server is up and running.

  • To stop the server, Press Ctrl + C in the terminal where the server is running

Running Backend

Make sure you have installed Golang from the above provided link

  • Install dependencies
cd server
go mod download
  • Run the development server
air
  • Open the browser and go to http://localhost:8000

If you encounter a browser error, it will be resolved upon starting the backend server.

Kindly refresh the page once the backend server is up and running.

  • To stop the server, Press Ctrl + C in the terminal where the server is running