HackShare

HackShare is the ultimate knowledge sharing platform for fellows where they can help each other learn new skills.

Getting Started

This guide will help you get the project up and running on your local machine for development and testing purposes. Have a look at deployment for notes on how to deploy the project on a live system.

Requirements

Make sure that you have the following requirements already installed in your system.

• NodeJs
• MongoDB

Installation Guidelines

A step by step guide on getting a development environment up and running

• Open terminal and run

git clone https://github.com/eKhattak/hackshare.git

This will grab a local copy of repository

• Open project directory in terminal

cd client
npm install
npm start

This will start React Application

Starting the development server...
Compiled successfully!

You can now view client in the browser.

  Local:            http://localhost:3000
  On Your Network:  http://192.168.10.6:3000

Note that the development build is not optimized.
To create a production build, use yarn build.

• Open project again in another terminal and run

cd server
npm install
npm start

This will start NodeJs Application

[nodemon] 2.0.4
[nodemon] to restart at any time, enter `rs`
[nodemon] watching path(s): *.*
[nodemon] watching extensions: js,mjs,json
[nodemon] starting `node app.js`

Deployment

Find the deployment guide here

Technology Stack

• ReactJs - An open-source JavaScript library for building user interfaces
• Nodejs - An open-source, cross-platform, JavaScript runtime environment
• MongoDB - A cross-platform document-oriented database program

Contributing to HackShare

All contributions, bug reports, bug fixes, documentation improvements, enhancements, and ideas are always welcome.

A detailed overview on how to contribute on HackShare can be found in the contributing guide.

Authors

• Anshul Goyal - Github
• Arsalan Khattak - Github
• Drew Alexandar - Github
• Rashika Karki - Github

See also the list of contributors.

License

This project is licensed under the MIT License - see the LICENSE file for details