scorelab · thishnika · Feb 14, 2018 · Feb 14, 2018 · Feb 14, 2018 · Feb 14, 2018
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,9 @@
+### Fixes #XXXX
+## Changes proposed in the pull request
+ *
+## Impact
+## Other information
+
+Check if you have done the following before creating the PR
+- [ ] console logs have been deleted
+- [ ] No commented code (If commented the reasons are given)
diff --git a/.github/issue_template.md b/.github/issue_template.md
@@ -0,0 +1,10 @@
+## Before you describe your issue, idea or feature, please consider using this issue template.
+
+## Type of issue:
+- [ ] Bug / Error
+- [ ] Idea / Feature
+- [ ] Improvement detail
+
+## Short description on the issue
+
+## Possible fix
diff --git a/.gitignore b/.gitignore
@@ -1 +1,154 @@
-stackle_app/package-lock.json
+# Created by https://www.gitignore.io/api/java,node,linux,windows,angular
+
+### Angular ###
+## Angular ##
+# compiled output
+/dist
+/tmp
+/app/**/*.js
+/app/**/*.js.map
+
+# dependencies
+/node_modules
+/bower_components
+
+# IDEs and editors
+/.idea
+
+# misc
+/.sass-cache
+/connect.lock
+/coverage/*
+/libpeerconnection.log
+npm-debug.log
+testem.log
+/typings
+
+# e2e
+/e2e/*.js
+/e2e/*.map
+
+#System Files
+.DS_Store
+
+### Java ###
+# Compiled class file
+*.class
+
+# Log file
+*.log
+
+# BlueJ files
+*.ctxt
+
+# Mobile Tools for Java (J2ME)
+.mtj.tmp/
+
+# Package Files #
+*.jar
+*.war
+*.ear
+*.zip
+*.tar.gz
+*.rar
+
+# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
+hs_err_pid*
+
+### Linux ###
+*~
+
+# temporary files which can be created if a process still has a handle open of a deleted file
+.fuse_hidden*
+
+# KDE directory preferences
+.directory
+
+# Linux trash folder which might appear on any partition or disk
+.Trash-*
+
+# .nfs files are created when an open file is removed but is still being accessed
+.nfs*
+
+### Node ###
+# Logs
+logs
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (http://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Typescript v1 declaration files
+typings/
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+
+
+### Windows ###
+# Windows thumbnail cache files
+Thumbs.db
+ehthumbs.db
+ehthumbs_vista.db
+
+# Folder config file
+Desktop.ini
+
+# Recycle Bin used on file shares
+$RECYCLE.BIN/
+
+# Windows Installer files
+*.cab
+*.msi
+*.msm
+*.msp
+
+# Windows shortcuts
+*.lnk
+
+# End of https://www.gitignore.io/api/java,node,linux,windows,angular
diff --git a/.travis.yml b/.travis.yml
@@ -1,2 +1,8 @@
 language: node_js
-script : stackle_api/server.js
+
+node_js:
+ - "node"
+install:
+ - cd stackle_api
+ - npm install
+script : node server.js &
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -0,0 +1,46 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [email protected]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/
diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md
@@ -0,0 +1,8 @@
+# Contributors
+==============
+
+Stackle is still new and it's a result of following people who contributed to it in many ways from concept to coding 
+* Charitha Madusanka [charithccmc](https://github.com/charithccmc)
+* Tharindu Ranathunga [tharindupr](https://github.com/tharindupr)
+* Milindu Sanoj Kumarage [agentMilindu](https://github.com/agentmilindu)
+* Pasan Missaka [psnmissaka](https://github.com/psnmissaka)
diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md
@@ -0,0 +1,41 @@
+# Prerequisites
+
+Please answer the following questions for yourself before submitting an issue. **YOU MAY DELETE THE PREREQUISITES SECTION.**
+
+- [ ] I am running the latest version
+- [ ] I checked the documentation and found no answer
+- [ ] I checked to make sure that this issue has not already been filed
+- [ ] I'm reporting the issue to the correct repository (for multi-repository projects)
+
+# Expected Behavior
+
+Please describe the behavior you are expecting
+
+# Current Behavior
+
+What is the current behavior?
+
+# Failure Information (for bugs)
+
+Please help provide information about the failure if this is a bug. If it is not a bug, please remove the rest of this template.
+
+## Steps to Reproduce
+
+Please provide detailed steps for reproducing the issue.
+
+1. step 1
+2. step 2
+3. you get it...
+
+## Context
+
+Please provide any relevant information about your setup. This is important in case the issue is not reproducible except for under certain conditions.
+
+* Firmware Version:
+* Operating System:
+* SDK version:
+* Toolchain version:
+
+## Failure Logs
+
+Please include any relevant log snippets or files here.
diff --git a/LICENSE b/LICENSE
@@ -186,7 +186,7 @@
  same "printed page" as the copyright notice for easier
  identification within third-party archives.
 
- Copyright {2017} {Sustainable Computing Research Lab}
+ Copyright {2018} {Sustainable Computing Research Lab}
 
  Licensed under the Apache License, Version 2.0 (the "License");
  you may not use this file except in compliance with the License.

diff --git a/README.md b/README.md
@@ -1,15 +1,21 @@
+![Stackle](https://gdurl.com/66Sl)
+
+[![Join the chat at https://gitter.im/scorelab/scorelab](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/scorelab/scorelab?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![GitHub license](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://raw.githubusercontent.com/scorelab/stackle/master/LICENSE) [![Travis Build](https://api.travis-ci.org/scorelab/Stackle.svg?branch=master)](https://travis-ci.org/scorelab/Stackle)
+
+
 # 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.
+Stackle is a 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 the administrator of an organization to create a forum thread for the particular organization. Users signing in are 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
+ - Front-End is developed using Angular
  - 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.
+Users interact with the application through the Angular 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.
 
+![Architecture](./stackle_app/app/images/architecture.jpg)
 ***
 
 # Setting Up the Project
@@ -29,20 +35,64 @@ These are the instructions on how to setup the project locally.
 
 For more information refer the [MongoDB manual](https://docs.mongodb.com/manual/administration/install-community/) on installing MongoDB Community edtion.
 
+### On Mac
+
+1. Download the binary files for the desired release of MongoDB.
+Download the binaries from the [MongoDB Download Center](www.mongodb.com/download-center).
+2. Extract the files from the downloaded archive.
+For example, from a system shell, you can extract through the tar command:
+```tar -zxvf mongodb-osx-ssl-x86_64-3.6.3.tgz```
+3. Copy the extracted archive to the target directory.
+Copy the extracted folder to the location from which MongoDB will run.
+```mkdir -p mongodb```
+```cp -R -n mongodb-osx-ssl-x86_64-3.6.3/ mongodb```
+4. Ensure the location of the binaries is in the PATH variable.
+The MongoDB binaries are in the bin/ directory of the archive. To ensure that the binaries are in your PATH, you can modify your PATH.
+For example, you can add the following line to your shell’s rc file (e.g. ~/.bashrc):
+```export PATH=<mongodb-install-directory>/bin:$PATH```
+Replace <mongodb-install-directory> with the path to the extracted MongoDB archive.
+
+## On Linux
+For Ubuntu,SUSE, and Debian systems, you can install mongoDB Community Edition using .deb packages. The process varies from distro to distro, so I suggest you visit the link below, select your distribution.
+
+Ubuntu terminal command:
+`sudo apt-get update
+sudo apt-get install -y mongodb-org`
+Debian terminal command:
+`sudo apt-get update
+sudo apt-get install -y mongodb-org`
+SUSE terminal command:
+`sudo zypper -n install mongodb-org`
+
+https://docs.mongodb.com/manual/administration/install-on-linux/
 
 ## 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`
+3. Once all the packages are installed run `npm start`
 
 ## Stackle App
-1. `cd`in to the **stackle_app** directory
-2. run `npm install` to install the packages required.
-3. Once all the packages are installed, run `gulp serve`
+Make sure you have the [angular-cli](https://cli.angular.io/) installed. 
+1. `cd` in to the **stackle-app** directory
+2. Run `npm install` to install the packages required.
+3. Once all the packages are installed, run `npm start` or `ng serve -o`
+
+## Running Tests (Protractor)
+1. Run `npm install -g protractor` to install protractor globally.
+2. To get started with a Selenium Server, run
+ ```
+ webdriver-manager update
+ webdriver-manager start
+ ```
+3. `cd` in to **root** directory and run `./ui-tests.sh`
+4. To add more tests, edit **stackle_tests.js** located in **stackle_app**
 
 # 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`
+ - If you are on Linux machine, execute the following steps to install compose. 
+ ```
+ sudo curl -L https://github.com/docker/compose/releases/download/1.17.0/docker-compose-`uname -s`-`uname -m` -o /usr/local/bin/docker-compose
+ sudo chmod +x /usr/local/bin/docker-compose
+ ```
 3. Once build completes, run `docker-compose up`
-
-