Skip to content

Latest commit

 

History

History
200 lines (132 loc) · 6.44 KB

README.md

File metadata and controls

200 lines (132 loc) · 6.44 KB
Raw

Community-Website

All Contributors Prettier Issues forks Netlify Status license Join our Slack community https://www.webiny.com/slack

HITK Tech Community 👩🏻‍💻👨🏻‍💻


Being from tier-2 and tier-3 colleges, you often face the problem of knowledge gap in our college days. But once you begin walking in the path of tech, you discover a place where people are just like you. 😇✨ We are a group of HITK students trying to fill the knowledge gap and help you find your place of discovery by sharing you the opportunities and resources at the right time!⏱️

This project aims to build the official site for the community page so that any student can use the resources shared by us.

Tech Stack 🗃

How to contribute ? 🤔

  • Get started with the Contributon Guidelines mentioned here
  • Make sure to follow our conventions mentioned here

Getting Started 👨‍💻

NOTE - You must be on NODE Version 14.19.0

Setup the repository to your local environment.

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

NVM

Setting Up Node version 14.19.0 and npm version 6.14.16

  1. Install Node Version Manager (nvm):
  2. Verify nvm Installation:
    • Open a terminal window.
    • Type the following command and press Enter:
nvm -v
  • This command should display the currently installed version of nvm.
  1. Install Node.js version 14.19.0:
    • In your terminal window, type the following command and press Enter:
nvm install 14.19.0
  1. Install npm version 6.14.16
npm install [email protected] -g
  1. Switch to Node.js version 14.19.0:
    • Use the following command to activate Node.js version 14.19.0:
nvm use 14
  1. Verify Node.js and npm Version:
    • Check the installed Node.js version by running:
node -v

  • The output should be v14.19.0.

  • Verify the installed npm version by running:

npm -v
  • The output should be 6.14.16

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.
cd frontend
  1. Install all the required packages and dependencies.
npm install
  1. Run the server.
npm start
  1. Click here to view it in the browser OR navigate to
http://localhost:3000

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.
cd backend
  1. Install all the required packages and dependencies.
npm install
  1. Run the server.
npm start
  1. Click here to see the backend server runing in the browser OR navigate to
http://localhost:3500

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

Testing Credentials 🤖

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

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

OR

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

Related Repositories 📂

Community 👥

Slack

Programs We have been associated with 🤍

Contributors 🌟

Thanks goes to these wonderful people ✨✨: