Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update README.md #1

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update README.md #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# 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
This is a comphrehesive guide on installing and running frontend and backend of the website on your machine. It is majorly written in [Javascript](https://www.javascript.com/), Shell, [Node 14.18.0](https://nodejs.org/ca/blog/release/v14.18.0/)

**Dependencies**
The project uses the following packages or Platforms that may have been used to serve the data.
Expand All @@ -22,8 +22,8 @@ The project uses the following packages or Platforms that may have been used to

**Basic Setup**
Clone the respective repositories from the following links:
[Front End]()
[Back End]()
[Front End](https://github.com/Hack-TeeEssGee/frontend)
[Back End](https://github.com/Hack-TeeEssGee/backend-node)

**Front End**
It's written mainly in React which uses React
Expand All @@ -42,7 +42,7 @@ It's mainly written in Yarn , Node 14.18.0

- run Yarn to install all node modules
- Run ```yarn start``` to start the backend server of local machine
- For dev , server replace BACKEND_URL with http://localhost:8000
- For dev, server replace BACKEND_URL with http://localhost:8000
- and Frontend_URL to http://localhost:3000

> You can visit the respective READMEs for [Front End](https://github.com/Hack-TeeEssGee/frontend/blob/master/README.md), [Back End](https://github.com/Hack-TeeEssGee/backend/blob/master/README.md) and [Back End Node](https://github.com/Hack-TeeEssGee/backend-node/blob/master/README.md).
> You can visit the respective READMEs for [Front End](https://github.com/Hack-TeeEssGee/frontend/blob/master/README.md), [Back End](https://github.com/Hack-TeeEssGee/backend/blob/master/README.md) and [Back End Node](https://github.com/Hack-TeeEssGee/backend-node/blob/master/README.md).