🖥️ Hash/Hub 🖥️

Tech Stack :

• Frontend: React
• Backend: Nodejs, express, MongoDB
• Version Control: Git and GitHub
• Hosting: gh-pages(frontend), heroku(backend)
• Code Editor and tools: VS Code

✨ Welcome to Hash/Hub ✨

Table of Contents

- Overview
- Technology & Dependencies Used
- Folder Structure
- UI of Website
- Contribution Guideline

Overview 🔨

Hash/Hub is initiative to provide students with everything that revolves around engineering degree, we have so many different free Tools to make thier Profile more Attractive and Professional. We have Fields section where they will find out resourses, roadmaps, experiences, programs, competetions, tips and tricks to not just master thier degree but also explore and enjoy every aspect of being an engineer with a full pack of knowledges. We have Blogs section where students can share their journey, achievements and tutorials, and can read the blogs for absolutley free.

Sample Video of Project Overview

Key Features

• Blogs
• Free Tools
  • Resume Maker
  • Smart pdf
  • Github Profile Readme Generator
  • Github Repository Readme Generator
  • Certificate Generator
• Fields
  • Open Source
  • AI
  • ML

Technology & Dependencies Used (Front-end) 🖥️

• React

• Material-UI (For Icons)

• AOS (For Scrolling Animations)

• carousel (For Card Slider)

• gh-pages (To host the React App)

• React-to-Print (To Convert my HTML to pdf and print)

• Axios (For API calls)

• Marked (To convert string into .md file)

  
  

Technology & Dependencies Used (Back-end) 🖥️

• bcryptjs

• body-parser

• cors

• express

• dotenv

• mongoose

• nodemon

  
  

Setup Steps

Frontend

• Go to directory

$ cd HashHub

• Install Dependencies

$ npm install

• Start LocalHost Server

$ npm run start

Backend

• Install Submodules

$ git submodule update --init

• Go the directory

$ cd Hashhub_Backend

• Start server (using nodemon)

$ nodemon start

Contribution Guidelines 🏗

Are we missing any of your favorite features, which you think you can add to it❓ We invite you to contribute to this project and make it better. To start contributing, follow the below guidelines:

1. Fork this repository.

2. Clone your forked copy of the project.

git clone https://github.com/vedant-jain03/HashHub.git

3. Navigate to the project directory 📁 .

cd HashHub

4. Add a reference(remote) to the original repository.

git remote add upstream https://github.com/vedant-jain03/HashHub.git

5. Check the remotes for this repository.

git remote -v

6. Always take a pull from the upstream repository to your master branch to keep it at par with the main project(updated repository).

git pull upstream main

7. Create a new branch.

git checkout -b <your_branch_name>

8. Perfom your desired changes to the code base.

9. Track your changes:heavy_check_mark: .

git add .

10. Commit your changes .

git commit -m "Relevant message"

11. Push the committed changes in your feature branch to your remote repo.

git push -u origin <your_branch_name>

12. To create a pull request, click on compare and pull requests.

13. Add appropriate title and description to your pull request explaining your changes and efforts done.

14. Click on Create Pull Request.

15 Voila ❗ You have made a PR to the awesome-javascript-projects 💥 . Wait for your submission to be accepted and your PR to be merged.