Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/khattakdev/hackshare
Teaching something is the best way to truly understand it. HackShare helps you find people to learn from and teach. Expand your expertise today.
https://github.com/khattakdev/hackshare
hackathon javascript mlh teaching
Last synced: 26 days ago
JSON representation
Teaching something is the best way to truly understand it. HackShare helps you find people to learn from and teach. Expand your expertise today.
- Host: GitHub
- URL: https://github.com/khattakdev/hackshare
- Owner: khattakdev
- License: mit
- Created: 2020-07-13T04:55:44.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2020-07-17T13:51:29.000Z (over 4 years ago)
- Last Synced: 2025-01-10T02:36:02.965Z (30 days ago)
- Topics: hackathon, javascript, mlh, teaching
- Language: JavaScript
- Homepage: https://www.mlhhackshare.ml/
- Size: 505 KB
- Stars: 4
- Watchers: 0
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# 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](https://nodejs.org/)
- [MongoDB](https://docs.mongodb.com/manual/administration/install-community/)
### 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](https://create-react-app.dev/docs/deployment/)
## Technology Stack
- [ReactJs](https://reactjs.org/) - An open-source JavaScript library for building user interfaces
- [Nodejs](https://nodejs.org/) - An open-source, cross-platform, JavaScript runtime environment
- [MongoDB](http://mongodb.com/) - 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](https://github.com/eKhattak/hackshare/blob/master/CONTRIBUTING.md).
## Authors
- **Anshul Goyal** - [Github](https://github.com/anshulrgoyal)
- **Arsalan Khattak** - [Github](https://github.com/eKhattak)
- **Drew Alexandar** - [Github](https://github.com/Drewbi)
- **Rashika Karki** - [Github](https://github.com/RashikaKarki)
See also the list of [contributors](https://github.com/ekhattak/hackshare/contributors).
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details