Skip to content

Getting Started πŸ‘¨β€πŸ’»

kajol edited this page Apr 25, 2021 · 1 revision

Setup the repository to your local environment.

  1. fork the repository - Creates a replica of repository to your local environment.
  2. Clone the repository using git clone https://github.com/YOUR-USERNAME/Community-Website - Downloads all repo files to your machine.
  3. cd Community-Website - Takes you to the root directory of the project.

Frontend βš›οΈ

Following are the steps to run the frontend of the community-website on your local. All the frontend code will go in the frontend directory.

  1. Navigate to frontend folder using cd frontend.
  2. Run npm install. It will install all the required packages and dependencies.
  3. Run npm start to run the server.
  4. Navigate to http://localhost:3000 to view it in the browser.

The website is live at https://hitk-tech-community.netlify.app/

Backend πŸ’»

Following are the steps to run the backend of the community-website on your local. All the backend code will go in the backend folder.

  1. Navigate to backend folder using cd backend
  2. Run npm install. It will install all the required packages and dependencies.
  3. Run npm start to run the server in dev mode.
  4. Navigate to http://localhost:3500 to see the backend server runing in the browser.

The backend is live at https://community-website-backend.herokuapp.com/

Testing Credentials πŸ€–

The dummy admin credentials to login to the admin dashboard are given below -

{
    "email" : "[email protected]",
    "password" : "check"
}