Octobox is a web app that helps people collect images, bookmarks and notes in a simple and visually pleasing way. It requires a Dropbox account and uses it almost exclusively for storage.
The app is live and functional! You can create an account at http://app.useoctobox.com.
To read about current areas of focus and contributing to the project head over to the Assembly page.
This repository
- Node.js - Download and Install Node.js. You can also follow this gist for a quick and easy way to install Node.js and npm.
- NPM - Node.js package manager; should be installed when you install node.js.
- Bower - Web package manager. Installing Bower is simple when you have
npm:
$ npm install -g bower
- Grunt - Download and Install Grunt.
$ npm install -g grunt-cli
- SASS - SASS is a CSS extension language used for styling Octobox frontend. You'll need the latest version of the SASS Ruby gem in order to build the stylesheets.
$ sudo gem install sass
After downloading the repo and installing these dependencies you'll need to run:
$ npm install
$ bower install
to download all the necessary project packages. After this step is complete, run grunt from the project directory to watch for file changes and recompile the JavaScript and SASS file changes. grunt isn't responsible for firing up a local server, so you'll have to do that separately.
Note: contributions to this project will only be accepted if they reference a design task in the respective project on Assembly and go through an artworking stage first or fix a bug or an issue.
Have a look at existing projects and tasks or start a discussion about what you’d like to be working on - you can do that on the Assembly project page.
- Create a Task that describes what you want to do. This gives others the opportunity to help and provide feedback.
- Fork the repo
- Create your feature branch
git checkout -b my-new-feature - Commit your changes
git commit -am 'Add some feature’ - Push to the branch
git push origin my-new-feature - Create new Pull Request which references the Task number.
We will accept patches that:
- Don’t break existing functionality.
- Are well documented and commented.
- Don’t add unnecessary dependencies - on the frontend don't use Bootstrap or jQuery, but use Angular jQlite, Lodash, Bourbon and Neat instead.
- Are written in strict Javascript only (no Coffeescript, sorry)
Visit Octobox project page on Assembly.