semarainc / Stackle

Stackle is an web communication portal aimed at providing Open Source organizations a platform to have discussions on their github projects and their issues. It provides Github intergration which allows adminstrator of an organization to create a forum thread for the particualr organization. Users signing in is able to view forums of the organizations they contribute to and engage in the forum discussions.

Introduction

Stackle is an web communication portal aimed at providing Open Source organizations a platform to have discussions on their GitHub projects and their issues. It provides GitHub integration which allows administrator of an organization to create a forum thread for the particular organization. Users signing in is able to view forums of the organizations they contribute to and engage in the forum discussions.

Implementation Details

MEAN stack is used for developing Stackle.

• Front-End is developed using AngularJS
• Back-end is handled by NodeJS using Express
• MongoDB is used as the databases for storing data related to stackle

Architecture

Users interact with the application through the AngularJS front-end which communicates with Node-API to get and post data to the MongoDB server. The front-end also communicates with GitHub API to get data related to Users, repositories and organizations. Users can login to the application through auth0 login integrated to Stackle.

---

Setting Up the Project

These are the instructions on how to setup the project locally.

Pre-requisites

• NodeJS 6.X or higher
• MongoDB Community edition

Installing MongoDB

On Windows

1. Download the lastest production release of MongoDB (3.4.6 or higher) from here.
2. Create the data directory to store all data. Create a the directory on the drive from which you start MongoDB. (Ex: If you are starting the MongoDB from the drive 'C'. You should create the directory as C:\data\db\ ).
3. To start the MongoDB, fire up a command line and run mongod.exe (ex: "C:\Program Files\MongoDB\Server\3.4\bin\mongod.exe" )
4. To connect to the MongoDB, use the mongo.exe shell. For that open up a command line an run mongo. (Ex: "C:\Program Files\MongoDB\Server\3.4\bin\mongo.exe" ).

For more information refer the MongoDB manual on installing MongoDB Community edtion.

Stackle API

1. cd in to the stackle_api directory.
2. Run npm install to install the packages required.
3. once all the packages are installed run npm start

Stackle App

1. cdin to the stackle_app directory
2. run npm install to install the packages required.
3. Once all the packages are installed, run gulp serve

Running with Docker

1. Change the url in the database config file in stackle_api/config/database.js as url : 'mongodb://mongo:27017/stackle'
2. In the root of the Stackle directory, run docker-compose build
3. Once build completes, run docker-compose up