https://github.com/tizz98/opendash

An Open Source Personal Dashboard (rails)
https://github.com/tizz98/opendash

Last synced: 9 days ago
JSON representation

An Open Source Personal Dashboard (rails)

• Host: GitHub
• URL: https://github.com/tizz98/opendash
• Owner: tizz98
• License: unlicense
• Created: 2014-10-24T21:57:22.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2015-11-11T22:49:53.000Z (about 9 years ago)
• Last Synced: 2024-04-22T15:22:49.784Z (7 months ago)
• Language: HTML
• Homepage: http://dash.zumh.org
• Size: 2.98 MB
• Stars: 4
• Watchers: 3
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# The Open Dashboard Project

This is an open source personal dashboard written on the [Rails](http://rubyonrails.org) web framework. A working version is hosted by [ZUMH](http://zumh.org) at [dash.zumh.org](http://dash.zumh.org). I hope this project will grow and prosper as time goes on. Also I hope someone finds this somewhat beneficial, besides myself of course.

Created by [Elijah Wilson](http://elijahwilson.me).

## Setup

### Environment Variables

In `config/secrets.yml`

- `DEV_SECRET_KEY_BASE`

- `TEST_SECRET_KEY_BASE`

- `SECRET_KEY_BASE` (_production secret key_)

In `config/production.rb` (_depreciated as of [a99ff93](https://github.com/tizz98/opendash/commit/a99ff93817d85fac24e66986cd82adbf67dd5fe6)_)

- `CDN_BASE` (_for use with AWS CloudFront for example_)

- `FONT_BASE` (_used with the `font_assets` gem, and coincidentally because of CloudFront_)

In `confing/newrelic.yml`

- `NEWRELIC_KEY` (_for use with NewRelic monitoring_)

### Requirements

- Ruby 2.0.0-p594

- Rails 4.1.6

- Postgresql

### Run locally

#### Database Setup

When installing gems you may get an error for `pg` which is the postgresql gem. In order to fix this you need to have postgresql already installed on your machine. On some systems you also may need to install a library to remedy this issue. This is obviously operating system dependant but for example here's what you might do on an ubuntu system:

`sudo apt-get install libpq-dev` then `gem install pg`

Make sure you have a user account for postgresql. If you don't or are not sure, run `sudo -i -u postgres` then `createuser --interactive`, now create a user with the same username you're using to run rails with. After you're done, `quit` and run `bin/rake db:create` and finally `bin/rake db:migrate`.

#### Running Server

To run this locally, clone this repository to wherever you like then run `bin/rake db:migrate`, `bin/rails server`, then head on over to [http://localhost:3000](http://localhost:3000).

_OR_

Use foreman & unicorn as a server to simulate a production environment. Make sure you have those installed and then run `bin/rake db:migrate`, `foreman start`, then head over to [http://localhost:3000](http://localhost:3000).

## TODOs

- GitHub wiki

- Allow adding/removing modules

	- Not more than one of the same

	- Must have at least one on the page

- Holidays

	- User able to toggle on/off

	- User set type/location of holidays

	- Off/None set by default

	- Changes the color scheme to compliment the holiday

- `create` redirection

	- Using rails `render :js` doesn't feel right

	- Better/more solid solution needed

- Compile assets on deploy

    - remove compiled assets from repo

    - add compiled asset dirs to `.gitignore`

## JavaScript Order (`dash.min.js`)

- date.min.js

- time.js

- codes.min.js

- weather.js

- news.js

- bootstrap-colorpicker.min.js

- helpers.js

- modernizr.custom.js

- classie.js

- menu.js

- modules.js

- jquery-ui.min.js

- portlets.js

- send.js

- stocks.js