MLH OriHack Board

As developers we sometimes forget to reach out for help from others. We get wrapped up in a problem and knock our heads around searching for the most optimized anwer. To attempt to solve this, we created a social platform where users can post issues or PRs linked to open source projects from GitHub. Then using their feed they can engage with other developers to both get valuable feedback and pose suggestions.

Technologies

• Vue.js
• Vuex
• Stylex
• MongoDB
• Express.js
• Node.js

Getting Started

Clone this repository along with all submodules and navigate to the cloned repository:

$ git clone --recurse-submodules https://github.com/sudiptog81/mlh-orihack.git
$ cd mlh-orihack

Navigate to the frontend folder, install project dependencies and create a production build:

mlh-orihack $ cd frontend
frontend $ npm install
frontend $ npm run build

Navigate to the backend folder, create a new file called .env from the given template in .env.example:

frontend $ cd ../backend
backend $ cp .env.example .env

Go to GitHub Developer Settings and create a new GitHub OAuth Application, note down the Client ID and generate a new Client Secret. Populate the Callback URL field with http://localhost:3000/auth/github/callback to work with the application locally. This would also be the time to note down the MongoDB connection URI. Populate the values in .env with these details.

Now, install project dependencies and start the application, while still being in the backend folder:

backend $ npm install
backend $ npm run start

Congratulations, the application should now be running at http://localhost:3000/.

Development

If you want to contribute to this project, you will need to set up a development environment. Ensure you can use the application after following the instructions given in the previous section.

On a terminal emulator, navigate to the frontend folder and execute the following command:

frontend $ npm run serve

On another terminal, navigate to the backend folder and execute the following command:

backend $ npm run dev

You can now access the application running on https://localhost:8080/. The development server will proxy all requests to the backend whenever needed.

License

The MIT Open Source License.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Joe Conwell 🎨 💻 🤔 👀

Desire Kaleba 💻 🤔 👀

Soham Parekh 💻 🤔 👀

Sudipto Ghosh 💻 📖 🤔 👀

Aayush Gupta 💻 ⚠️ 📖

This project follows the all-contributors specification. Contributions of any kind welcome!

This repository was created by the members of Pod 3.0.0 "Fast Tortoise" for the MLH Fellowship Orientation Hackathon.