https://github.com/doowb/octobox.js
Take back control of your GitHub Notifications! (Port of octobox to node.js)
https://github.com/doowb/octobox.js
Last synced: about 2 months ago
JSON representation
Take back control of your GitHub Notifications! (Port of octobox to node.js)
- Host: GitHub
- URL: https://github.com/doowb/octobox.js
- Owner: doowb
- License: agpl-3.0
- Created: 2017-01-05T16:50:12.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-03-19T23:01:15.000Z (about 7 years ago)
- Last Synced: 2025-02-25T07:08:07.712Z (2 months ago)
- Language: JavaScript
- Homepage: https://octoboxjs.io
- Size: 150 KB
- Stars: 52
- Watchers: 5
- Forks: 7
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: contributing.md
- License: LICENSE
Awesome Lists containing this project
README
# octobox.js
> Port of octobox to node.js
[](https://octoboxjs.io)
## Table of Contents
Table of Contents
- [Motivation](#motivation)
- [Usage](#usage)
- [Requirements](#requirements)
- [Deployment to Heroku](#deployment-to-heroku)
- [Development](#development)
* [Getting started](#getting-started)
+ [Local database](#local-database)
+ [GitHub OAuth Application](#github-oauth-application)
+ [Configuration](#configuration)
+ [Start](#start)
- [About](#about)
* [Related projects](#related-projects)
* [Contributing](#contributing)
* [Running tests](#running-tests)
* [Author](#author)
* [License](#license)
## Motivation
This is a port of [Octobox](https://github.com/octobox/octobox) from Ruby to JavaScript using [express](http://expressjs.com/), [sequelize](https://github.com/sequelize/sequelize), and [handlebars](http://www.handlebarsjs.com/) instead of Rails, ActiveDirectory, and erb.
The goal is to learn more about the pieces of Rails and ActiveDirectory that are missing from Node.js and fill the gap by using other tools like [assemble](https://github.com/assemble/assemble) and [generate](https://github.com/generate/generate) and by creating missing tools like [helper-octicon](https://github.com/helpers/helper-octicon).
You can also read about the original motivation and features of the Octobox project [here](https://github.com/octobox/octobox#why-is-this-a-thing).
## Usage
There is [a hosted version](https://octoboxjs.io) available to try now.
You may also [deploy to heroku](#deployment-to-heroku) and host it yourself.
## Requirements
Web notifications must be enabled in your GitHub settings for Octobox.js to work: https://github.com/settings/notifications
## Deployment to Heroku
You can host your own instance of Octobox.js using Heroku.
[](https://heroku.com/deploy)
Heroku will ask you to provide a `GitHub Client ID` and `GitHub Client Secret` which you can get from GitHub by creating a new [OAuth Application](#github-oauth-application).
Optionally, you may set a Google Analytics Tracking ID that will place the Google Analytics script in each page.
## Development
The source code is hosted at [GitHub](https://github.com/doowb/octobox.js).
### Getting started
Since this is a port to Node.js, you'll need [Node.js](https://nodejs.org) and [NPM](https://www.npmjs.com/). NPM will be installed when installing Node.js.
Once you have Node.js installed, git clone the repository:
```sh
$ git clone https://github.com/doowb/octobox.js.git
```
Then install the npm dependencies:
```sh
$ cd octobox.js
$ npm install
```
#### Local database
You'll need a local PostgreSQL database installed. On OSX you may use [Homebrew](http://mxcl.github.io/homebrew/) or the [PostgresApp](http://postgresapp.com). Please see these [further instructions for installing Postgres via Homebrew](http://www.mikeball.us/blog/setting-up-postgres-with-homebrew/).
```sh
$ brew install postgres
```
On Debian-based Linux distributions you can use apt-get to install Postgres:
```sh
$ sudo apt-get install postgresql postgresql-contrib libpq-dev
```
Next, you'll need to create the `development` and `test` databases:
Using `psql`:
```sh
$ psql
```
Create `octobox_development` and `octobox_test` databases:
```sql
> CREATE DATABASE octobox_development;
> CREATE DATABASE octobox_test;
```
Optionally, you may create a "production" database named `octobox`:
```sql
> CREATE DATABASE octobox;
```
These database names may be changed as long as the [configuration files](#configuration) are changed to reflect the same names.
#### GitHub OAuth Application
Register a new [OAuth Application](https://github.com/settings/applications/new) for your development environment using the following settings:
If you're deploying this to production, just replace `http://localhost:3000` with your application's URL.
#### Configuration
The repository has `config.json` files ignored in [.gitignore](./.gitignore) to allow for keeping secrets, for your development environment, private. There are 2 files that should be added.
The first is `config.json` in the root of the project:
```json
{
"url": "http://localhost:3000",
"GITHUB_CLIENT_ID": "YOUR_GITHUB_CLIENT_ID",
"GITHUB_CLIENT_SECRET": "YOUR_GITHUB_CLIENT_SECRET",
"ga": {"trackingId": "YOUR_GA_TRACKING_ID"}
}
```
This file contains the following properties:
* `url`: Site URL (used for building links)
* `GITHUB_CLIENT_ID`: Your GITHUB_CLIENT_ID from your [OAuth Application](#github-oauth-application)
* `GITHUB_CLIENT_SECRET`: Your GITHUB_CLIENT_SECRET from your [OAuth Application](#github-oauth-application)
* `ga`: An object with a `trackingId` property that has your Google Analytics tracking id. This is optional and if left out will leave out the Google Analytics code.
The second file is `db/config.json` in the `db` folder:
```json
{
"development": {
"username": "doowb",
"password": null,
"database": "octobox_development",
"host": "127.0.0.1",
"dialect": "postgres"
},
"test": {
"username": "doowb",
"password": null,
"database": "octobox_test",
"host": "127.0.0.1",
"dialect": "postgres"
},
"production": {
"use_env_variable": "DATABASE_URL"
}
}
```
This file contains the environment based configurations for the [PostgreSQL database](#local-database).
Each environment (`development`, `test`, `production`) may have different configuration objects. Each configuration object may have the following properties:
* `username`: PostgreSQL username
* `password`: PostgreSQL password
* `database`: PostgreSQL database (this should match the database created [earlier](#local-database))
* `host`: Where the database is located
* `dialect`: "postgres" This should be "postgres" if you're following this Readme. Since this project uses [sequelize](https://github.com/sequelize/sequelize), you have an option to use another database engine if you'd like.
* `use_env_variable`: Rather than setting all of the properties above, you may set a connection string on an environment variable and specify this variable here. When [deploying to Heroku](#deployment-to-heroku) this is the option that's used and the default environment variable is `DATABASE_URL`.
#### Start
Now you can start the Node.js application using the following command:
```sh
$ npm start
```
If there are no errors, you can open the app in a browser at [http://localhost:3000](http://localhost:3000) and login through GitHub.
## About
### Related projects
* [assemble](https://www.npmjs.com/package/assemble): Get the rocks out of your socks! Assemble makes you fast at creating web projects… [more](https://github.com/assemble/assemble) | [homepage](https://github.com/assemble/assemble "Get the rocks out of your socks! Assemble makes you fast at creating web projects. Assemble is used by thousands of projects for rapid prototyping, creating themes, scaffolds, boilerplates, e-books, UI components, API documentation, blogs, building websit")
* [express](https://www.npmjs.com/package/express): Fast, unopinionated, minimalist web framework | [homepage](http://expressjs.com/ "Fast, unopinionated, minimalist web framework")
* [generate](https://www.npmjs.com/package/generate): Command line tool and developer framework for scaffolding out new GitHub projects. Generate offers the… [more](https://github.com/generate/generate) | [homepage](https://github.com/generate/generate "Command line tool and developer framework for scaffolding out new GitHub projects. Generate offers the robustness and configurability of Yeoman, the expressiveness and simplicity of Slush, and more powerful flow control and composability than either.")
* [helper-octicon](https://www.npmjs.com/package/helper-octicon): Template helper for displaying octicon SVGs. Should work with any Handlebars, Lo-Dash, underscore or any… [more](https://github.com/helpers/helper-octicon) | [homepage](https://github.com/helpers/helper-octicon "Template helper for displaying octicon SVGs. Should work with any Handlebars, Lo-Dash, underscore or any template engine that allows helper functions to be registered. Also compatible with verb, assemble, and templates.")
* [sequelize](https://www.npmjs.com/package/sequelize): Multi dialect ORM for Node.JS/io.js | [homepage](https://github.com/sequelize/sequelize#readme "Multi dialect ORM for Node.JS/io.js")
* [update](https://www.npmjs.com/package/update): Be scalable! Update is a new, open source developer framework and CLI for automating updates… [more](https://github.com/update/update) | [homepage](https://github.com/update/update "Be scalable! Update is a new, open source developer framework and CLI for automating updates of any kind in code projects.")
* [verb](https://www.npmjs.com/package/verb): Documentation generator for GitHub projects. Verb is extremely powerful, easy to use, and is used… [more](https://github.com/verbose/verb) | [homepage](https://github.com/verbose/verb "Documentation generator for GitHub projects. Verb is extremely powerful, easy to use, and is used on hundreds of projects of all sizes to generate everything from API docs to readmes.")
### Contributing
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
Please read the [contributing guide](contributing.md) for avice on opening issues, pull requests, and coding standards.
### Running tests
Install dev dependencies:
```sh
$ npm install -d && npm test
```
### Author
**Brian Woodward**
* [github/doowb](https://github.com/doowb)
* [twitter/doowb](http://twitter.com/doowb)
### License
Copyright © 2017, [Brian Woodward](https://github.com/doowb).
Released under the [AGPL-3.0 license](LICENSE).
***
_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.2.3, on January 08, 2017._