Removed the fork me ribbon

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,35 @@
+### Please describe the problem (or idea)
+
+> What happened just before the problem occurred? Or what problem could this idea solve?
+
+
+
+> What did you expect to see that you didn't?
+
+
+
+### Please show us where to look
+
+https://code.publiclab.org/ ...
+
+
+### What's your PublicLab.org username?
+
+> This can help us diagnose the issue: 
+
+
+
+### Browser, version, and operating system
+
+> Many bugs are related to these -- please help us track it down and reproduce what you're seeing!
+
+
+****
+
+## Thank you!
+
+Your help makes Public Lab better! We *deeply* appreciate your helping refine and improve this site. 
+
+To learn how to write really great issues, which increases the chances they'll be resolved, see:
+
+https://publiclab.org/wiki/developers#Contributing+for+non-coders

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,17 @@
+Make sure these boxes are checked before your pull request (PR) is ready to be reviewed and merged. Thanks!
+
+* [ ] tests pass -- look for a green checkbox ✔️ a few minutes after opening your PR -- or run tests locally with `rake test`
+* [ ] code is in uniquely-named feature branch and has no merge conflicts
+* [ ] PR is descriptively titled
+* [ ] PR body includes `fixes #0000`-style reference to original issue #
+* [ ] ask `@publiclab/reviewers` for help, in a comment below
+
+> We're happy to help you get this ready -- don't be afraid to ask for help, and **don't be discouraged** if your tests fail at first!
+
+If tests do fail, click on the red `X` to learn why by reading the logs.
+
+Please be sure you've reviewed our contribution guidelines at https://publiclab.org/contributing-to-public-lab-software
+
+We have a loose schedule of reviewing and pulling in changes every Tuesday and Friday, and publishing changes on Fridays. 
+
+Thanks!

.github/config.yml

@@ -2,21 +2,25 @@
 
 # Configuration for new-issue-welcome - https://github.com/behaviorbot/new-issue-welcome
 
-# Comment to be posted to on first-time issues
+# Comment to be posted to on first time issues
 newIssueWelcomeComment: |
   Thanks for opening your first issue here! Please follow the issue template to help us help you 👍🎉😄
-  If you have screenshots to share demonstrating the issue, that's really helpful! 📸
-
+  If you have screenshots to share demonstrating the issue, that's really helpful! 📸 You can [make a gif](https://www.cockos.com/licecap/) too!
 # Configuration for new-pr-welcome - https://github.com/behaviorbot/new-pr-welcome
 
+# Comment to be posted to on PRs from first time contributors in your repository
+newPRWelcomeComment: |
+ Thanks for opening this pull request! `Dangerbot` will test out your code and reply in a bit with some pointers and requests.
+ There may be some errors, **but don't worry!** We're here to help! 👍🎉😄
 # Configuration for first-pr-merge - https://github.com/behaviorbot/first-pr-merge
 
 # Comment to be posted to on pull requests merged by a first time user
 firstPRMergeComment: |
  Congrats on merging your first pull request! 🙌🎉⚡️ 
- Your code will likely be published to code.publiclab.org in the next few days. 
+ Your code will likely be published to https://code.publiclab.org in the next few days. 
  In the meantime, can you tell us your Twitter handle so we can thank you properly?
- Now that you've completed this, you can help someone else take their first step! See: https://code.publiclab.org
+ Now that you've completed this, you can help someone else take their first step!
+ See: [Public Lab's coding community!](https://code.publiclab.org)
 
 # It is recommended to include as many gifs and emojis as possible
 

.github/dependabot.yml

@@ -0,0 +1,28 @@
+version: 2
+updates:
+- package-ecosystem: npm
+  directory: "/"
+  schedule:
+    interval: daily
+  open-pull-requests-limit: 10
+  ignore:
+  - dependency-name: chart.js
+    versions:
+    - 3.0.2
+    - 3.1.0
+    - 3.1.1
+  - dependency-name: y18n
+    versions:
+    - 4.0.1
+    - 4.0.2
+  - dependency-name: ini
+    versions:
+    - 1.3.8
+  - dependency-name: jest-when
+    versions:
+    - 3.1.0
+    - 3.2.0
+  - dependency-name: tape
+    versions:
+    - 5.1.1
+    - 5.2.0

.github/first-timers-issue-template.md

@@ -0,0 +1,47 @@
+Hi, this is a [first-timers-only issue](https://publiclab.github.io/community-toolbox/#r=all). This means we've worked to make it more legible to folks who either **haven't contributed to our codebase before, or even folks who haven't contributed to open source before**. 
+
+If that's you, we're interested in helping you take the first step and can answer questions and help you out as you do. Note that we're especially interested in contributions from people from groups underrepresented in free and open source software!
+
+We know that the process of creating a pull request is the biggest barrier for new contributors. This issue is for you 💝
+
+If you have contributed before, **consider leaving this one for someone new**, and looking through our general [help wanted](https://github.com/publiclab/plots2/labels/help-wanted) issues. Thanks!
+
+### 🤔 What you will need to know.
+
+Nothing. This issue is meant to welcome you to Open Source :) We are happy to walk you through the process.
+
+### 📋 Step by Step
+
+- [ ] 🙋 **Claim this issue**: Comment below. If someone else has claimed it, ask if they've opened a pull request already and if they're stuck -- maybe you can help them solve a problem or move it along!
+
+- [ ] 📝 **Update** the file [$FILENAME]($BRANCH_URL) in the `$REPO` repository (press the little pen Icon) and edit the line as shown below. 
+
+[See this page](https://publiclab.github.io/community-toolbox/#r=all) for some help in taking your first steps!
+
+Below is a "diff" showing in red (and a `-`) which lines to remove, and in green (and a `+`) which lines to add:
+
+```diff
+$DIFF
+```
+
+
+- [ ] 💾 **Commit** your changes
+
+- [ ] 🔀 **Start a Pull Request**. There are two ways how you can start a pull request:
+
+1. If you are familiar with the terminal or would like to learn it, [here is a great tutorial](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github) on how to send a pull request using the terminal.
+
+2. You can also [edit files directly in your browser](https://help.github.com/articles/editing-files-in-your-repository/) and open a pull request from there. 
+
+- [ ] 🏁 **Done** Ask in comments for a review :)
+
+
+### 🤔❓ Questions?
+
+Leave a comment below!
+
+### Is someone else already working on this?
+
+We encourage you to link to this issue by mentioning the issue # in your pull request, so we can see if someone's already started on it. **If someone seem stuck, offer them some help!** Otherwise, [take a look at some other issues you can help with](https://publiclab.github.io/community-toolbox/#r=all). Thanks!
+
+(This issue was created by [First-Timers-Bot](https://github.com/hoodiehq/first-timers-bot).)

.github/first-timers.yml

@@ -0,0 +1,12 @@
+# You can change the labels to suit your needs if "first-timers-only" is not what you are looking for.
+# These are some examples.
+labels:
+  - first-timers-only
+  - help-wanted
+
+#If you would like to add your own template for the issue, add an .md file to your .github folder
+template: .github/first-timers-issue-template.md
+
+# You can create the issue in a different repo than where the problem is. Just make sure you installed the bot on the configured repository.
+# The issue will link back to the original repository where the contribution will be made.
+#repository: repo-name 

.github/workflows/tests.yml

@@ -0,0 +1,33 @@
+# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
+# For more information see: https://help.github.com/actions/language-and-framework-guides/publishing-nodejs-packages
+
+name: Tests
+
+on: [pull_request]
+jobs:
+ tests:
+    runs-on: ubuntu-18.04
+    steps:
+    - uses: actions/checkout@v2
+    - name: Setup node
+      uses: actions/setup-node@v2
+      with:
+        node-version: '12'
+        check-latest: true
+    - name: Cache node modules
+      uses: actions/cache@v2
+      env:
+        cache-name: cache-node-modules
+      with:
+        path: ~/.npm
+        key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json') }}
+        restore-keys: |
+          ${{ runner.os }}-build-${{ env.cache-name }}-
+          ${{ runner.os }}-build-
+          ${{ runner.os }}-
+    - name: Install Dependencies
+      run: npm install
+    - name: "Build dist files"
+      run: grunt build
+    - name: "Run tests"
+      run: npm test

.gitpod.yml

@@ -0,0 +1,3 @@
+tasks:
+  - init: npm install
+    command: npm run start

.travis.yml

@@ -0,0 +1,9 @@
+language: node_js
+node_js:
+  - '8'
+  - '10'
+before_install:
+  - npm install -g grunt-cli
+before_script:
+  - grunt build
+script: npm test

CODE_OF_CONDUCT.md

@@ -0,0 +1,11 @@
+# Public Lab Code of Conduct 
+
+_Public Lab, 55 Cromwell Street, 1C, Providence, RI 02907_
+
+We are coming together with an intent to care for ourselves and one another as we produce knowledge in pursuit of environmental justice. For this to work for everybody, individual decisions will not be allowed to run counter to the welfare of other people. We—visitors, community members, community moderators, staff, organizers, sponsors, and all others—hold ourselves accountable to the same values regardless of position or experience. This community aspires to be a respectful place both during online and in-person interactions so that all people are able to fully participate with their dignity intact. This document is a piece of the culture we're creating.
+
+This code of conduct applies to all spaces managed by the Public Lab community and non-profit, both online and in person. It provides a clear set of practical guidelines for events led by organizers and community members, multi-day events such as Barnraisings, and online venues such as the website, comment threads on software platforms, chatrooms, our mailing lists, the issue tracker, and any other forums created by Public Lab which the community uses for communication. For interactions with additional groups, see our Partnership Guidelines at https://publiclab.org/partners.
+
+To read the full Code of Conduct and learn how to contact the Conduct Committee or the Moderators group, see:
+
+https://publiclab.org/conduct

Gruntfile.js

@@ -14,7 +14,6 @@ module.exports = function(grunt) {
           },
           source: {
               files: [
-                  'src/*.js',
                   'src/*/*.js',
                   'Gruntfile.js'
               ],
@@ -24,7 +23,7 @@ module.exports = function(grunt) {
 
       browserify: {
           dist: {
-            src: ['src/community-toolbox.js'],
+            src: ['src/scripts/community-toolbox.js'],
             dest: 'dist/community-toolbox.js'
           }
       }

README.md

@@ -1,73 +1,79 @@
-Community Toolbox
-====
+[![Gitpod ready-to-code](https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/publiclab/community-toolbox)
 
-A toolbox of a GitHub organization's contributor community.
+## Community Toolbox
 
-See a live instance (set up for Public Lab's community) at: http://code.publiclab.org/
+A platform dedicated to community growth and getting insights on organization-wide activities.
 
+[![Code of Conduct](https://img.shields.io/badge/code-of%20conduct-green.svg)](https://publiclab.org/conduct)
+[![first-timers-only-friendly](http://img.shields.io/badge/first--timers--only-friendly-lightgray.svg?style=flat-square)](https://code.publiclab.org#r=all)
+[![Join the chat at https://publiclab.org/chat](https://img.shields.io/badge/chat-in%20different%20ways-blue.svg)](https://publiclab.org/chat)
+[![visit here](https://img.shields.io/badge/live_at-URL-yellow)](https://code.publiclab.org/)
+[![GitHub license](https://img.shields.io/github/license/publiclab/community-toolbox)](https://github.com/publiclab/community-toolbox/blob/main/LICENSE)
+[![GitHub stars](https://img.shields.io/github/stars/publiclab/community-toolbox)](https://github.com/publiclab/community-toolbox/stargazers)
+[![Newcomers welcome](https://img.shields.io/badge/newcomers-welcome-pink.svg)](https://code.publiclab.org)
 
-## Embed an issues list
 
-Community Toolbox lets you view issues of a specific repository for embedding on another site, with the following URL:
+## Table of Contents
 
-http://code.publiclab.org/examples/embed.html#o=orgname&r=repository
+1. [Project Overview](#project-overview)
+2. [Getting Started](./docs/getting_started.md)
+2. [How to Use](./docs/usage.md)
 
-For issues with a specific label, use, for example: 
 
-http://code.publiclab.org/community-toolbox/examples/embed.html#o=orgname&r=repository&l=first-timers-only
+## Project Overview
 
-To embed these on your site, use an `<iframe>` like this:
+The project structure of community toolbox is majorly divided into two groups,
+- `/examples` contains code responsible for front-end styles and related scripts,
+- `/src` contains the actual code for fetching data and showing it to the user.
 
-```html
-<iframe src="http://code.publiclab.org/examples/embed.html#o=orgname&r=repository" style="border:none;" width="100%" height="600px"></iframe>
-```
+![](./images/overview.png)
 
-## Org-wide issues
+As shown in the flowchart, `/src` inherits MVC like architecture. Here,
 
-You can also use Community Toolbox to display issues for a given label across an entire organization. Use `all` for the `r` parameter, like this:
+Fragment | Contains
+--- | ---
+`/models` | database related operations (Database layer)
+`/scripts` | main source file (community-toolbox.js)
+`/utils` | utility functions (Controller layer)
+`/UI` | user interface functions (View layer)
 
-http://code.publiclab.org/#r=all
+---
 
-## Configuration
+### models
 
-[These lines](https://github.com/publiclab/community-toolbox/blob/620c4d906be704ffaa5b40509796c18c393f83f4/index.html#L115-L118) allow configuration of the example to set **repository, organization** and **labels** to use, by adding to the URL hash in the format: `https://publiclab.github.io/community-toolbox/#r=all` (for the `r` parameter, as an example). So the options are:
+`models/` corresponds to the **Database Layer**. It is responsible for all the operations that happen on the database i.e., create, read and delete operations. The structure of `models/` ensures the segregation of code chunks based on their responsibilities.
 
-* **repository** - using `r=` you can set the repository name to look at, like: http://code.publiclab.org#r=plots2 for https://github.com/publiclab/plots2
-* **organization/user** - using `o=` you can set the organization or user name to look at, like: http://code.publiclab.org#o=publiclab for https://github.com/publiclab
-* **first-timers-only label** - using `f=` you can set the label to use for `first-timers-only` or equivalent issues, like: http://code.publiclab.org#f=help-wanted for https://github.com/publiclab/plots2/labels/help-wanted
-* **first timers only "candidates"** - using `c=` you can set the label to use for `fto-candidate` or equivalent issues (at Public Lab, we keep a queue of not-quite-ready-but-almost issues for newcomers, that have key information but aren't completely formatted to welcome yet), like: http://code.publiclab.org#c=fto-candidate for https://github.com/publiclab/plots2/labels/fto-candidate
+There are 3 major categories to this:
+- Setting up/initializing the database (initialize.js),
+- Defining operations for the database (crud.js), and
+- Providing a layer to communicate with the outside code (utils.js)
 
+![](./images/models.png)
 
-## Developing
 
-To develop and build out Community Toolbox, you'l need to have `npm` installed and to run `npm install` to get all the dependencies. 
+### scripts
 
-Community Toolbox is built using a Grunt task from the source files in `/src/`, and the compiled file is saved to `/dist/community-toolbox.js`. To build, run `grunt build`. To watch files for changes, and build whenever they occur, run `grunt`. 
+`scripts/` contains the main entry point **_community-toolbox.js_** which is responsible for plugging every single functionality to the website. This file provides an interface to communicate with every feature that is present or is to be added later on. This file then gets bundled up with the help of grunt and that bundled-up version of the file is injected into the website as a script with the help of the landing page html file (index.html).
 
-API calls are based on: https://www.npmjs.com/package/github-api-simple
 
-## Install Instructions
-* Clone or download the repo. into any fresh temporary folder.
+### utils
 
-   ``` git clone https://github.com/publiclab/community-toolbox.git ```
+`utils/` acts as a **Controller Layer**, it contains code for various different features, majority of the code for any feature is present in this folder. This is to follow our approach of keeping main logic separate from the interface file (community-toolbox.js). This helps in making the code more readable and maintainable.
 
-* Cd into that root folder you just cloned locally.
 
-   ``` cd community-toolbox ```
+![](./images/utilscripts.png)
 
-* Open terminal in the current folder and to install all dependencies type
+### UI
 
-   ```npm install ```
-
-   Update to new version of packages if required in package.json.
-
-* Now go to the folder and open index.html in browser.
+`UI/` acts as a **View Layer**, it is responsible for displaying data on the landing page. Data is given to UI functions and its their job to display that data on to the screen. These functions are broken up into different units according to the data they display.
 
+- Data for repository contributors is displayed on the screen with the help of **_contributorsUI.js_**,
+- Similarly, **_recentContributorsUI.js_** shows recent contributors' data on to the page, and likewise other functions show data accordingly.
 
-## Testing
 
-(testing is not yet implemented, but when it is, it'll probably work like this)
+![](./images/UI.png)
 
-Assuming `tape` is installed via `npm install`:
 
-`npm test`
+### Up next
+
+ - ### [Getting started guide](./docs/getting_started.md)

config.json

@@ -0,0 +1,20 @@
+{
+    "org-heading-name": "Public Lab",
+    "org": "publiclab",
+    "default-repository": "plots2",
+    "URL": "https://code.publiclab.org",
+    "favicon-link": "https://i.publiclab.org/system/images/photos/000/000/354/medium/Boots-ground-02.png",
+    "forkMe-ribbon-link": "https://github.com/publiclab/community-toolbox",
+    "code-of-conduct-link": "https://publiclab.org/conduct",
+    "README-link": "https://github.com/publiclab/plots2/blob/main/README.md",
+    "official-chatroom-link": "https://publiclab.org/chat",
+    "gitter-chatroom-link": "https://gitter.im/publiclab/publiclab",
+    "issue-label-for-newcomer": "first-timers-only",
+    "issue-label-for-issues-like-newcomer": "candidates",
+    "help-wanted-issue-label": "help-wanted",
+    "support-issue-label": "support",
+    "newcomer-welcoming-guidelines-page-link": "https://publiclab.org/n/13667",
+    "other-ways-to-support-guidelines-link": "https://publiclab.org/n/13687",
+    "facebook-link": "https://www.facebook.com/PublicLab/",
+    "twitter-link": "https://twitter.com/PublicLab?ref_src=twsrc%5Egoogle%7Ctwcamp%5Eserp%7Ctwgr%5Eauthor"
+}