Skip to content

Hack-TeeEssGee/docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Installation Guide for KGPverse

This is a comphrehesive guide on installing and running frontend and backend of the website on your machine. It is majorly written in Javascript, Shell, Node 14.18.0

Dependencies

The project uses the following packages or Platforms that may have been used to serve the data.

  • Yarn
  • Node js
  • prettier using husk
  • React
  • One Signal
  • PM2 as daemon process manager
  • Nginx
  • AWS EC2 Instance for backend deployment
  • Netlify for frontend deployment
  • Different Dev and Production for better management
  • Cloudflare as DNS
  • DNS Caching through Cloufflare
  • Postgres Database from free SUPABASE instance
  • Google sheets for easy data control for non techincal people

Basic Setup

Clone the respective repositories from the following links:

Front End

It's written mainly in React which uses React

  • Run backend with localhost .env
  • Clone project. inside project root directory, run the command yarn
  • after installation of the packages is over, run the command yarn start to start the development server in port 3000.

Back End

It's mainly written in Yarn , Node 14.18.0

  • Add env to root of folder
  • Add gsheets.json to root of folder

we are using Yarn as a package manager

You can visit the respective READMEs for Front End and Back End Node.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages