Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bucketsio/buckets
[DEPRECATED] Manage content better.
https://github.com/bucketsio/buckets
Last synced: about 1 month ago
JSON representation
[DEPRECATED] Manage content better.
- Host: GitHub
- URL: https://github.com/bucketsio/buckets
- Owner: bucketsio
- License: agpl-3.0
- Archived: true
- Created: 2014-04-25T20:38:42.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2015-05-31T04:57:37.000Z (over 9 years ago)
- Last Synced: 2024-04-26T17:44:45.051Z (7 months ago)
- Language: CoffeeScript
- Homepage: https://assembly.com/buckets
- Size: 6.31 MB
- Stars: 1,053
- Watchers: 86
- Forks: 149
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-starred - bucketsio/buckets - [DEPRECATED] Manage content better. (others)
README
A fast, simple way to build dynamic websites with [Node.js](http://nodejs.org). [More about our vision](docs/vision/vision.md).
[](https://travis-ci.org/asm-products/buckets)
[](https://david-dm.org/asm-products/buckets)
[](LICENSE.md)
[](https://www.npmjs.org/package/buckets)
# Getting Started
Buckets requires [Node.js](http://nodejs.org) and [MongoDB](http://www.mongodb.org). Once you have those, the easiest way to use Buckets is to install it as an NPM module:
```bash
npm install buckets
```
You can also run the above command with `--save` to add Buckets to your app’s package.json (recommended). From here, you can run Buckets in a script like this:
```javascript
buckets = require('buckets');
buckets({
buildsPath: __dirname + "/builds/",
// Add your Gmail to use features that send email (Mandrill and others also supported)
smtp:
// Additional configuration…
});
```
There is a [skeleton project available](https://github.com/bucketsio/skeleton) which uses the above configuration as a sample. If you plan on deploying to [Heroku](http://heroku.com/), you can also optionally use the button below to get started—which will deploy the skeleton project to Heroku, automatically adding free plans for any necessary services.
[](https://heroku.com/deploy?template=https://github.com/bucketsio/skeleton)
## Installing from this repo
If you plan on contributing to Buckets' development, you can install and deploy Buckets directly from this repo. You will need to install a few extra dependencies for building the frontend files.
```bash
npm install -g grunt-cli
npm install
```
This will install [Grunt](http://gruntjs.com/) globally and Buckets' dependencies (including devDependencies). Grunt can then be used for most tasks, as shown below.
### Building
You can compile the Buckets client-side assets by running `grunt`. This will build all of the JavaScript/CSS unminified, and with source maps. If you'd like to see what the final (compressed) output will be, run `grunt prepublish` instead.
### Running
Once the client-side assets has been compiled, you can run `npm start` to start the Buckets server and your site should be accessible at the default address: [http://localhost:3000/](http://localhost:3000/).
Alternatively, you can run `grunt start`—this also starts a server at the default address, but will additionally watch all files for changes. Any changes to server CoffeeScript will restart the web server and then reload the browser. Any changes to client-side CoffeeScript, Stylus, or Handlebars will re-compile the appropriate files, then reload the browser.
There are a few other Grunt tasks available for [building](docs/frontend.md) and [running tests](docs/tests.md).
### Deploying
If you're deploying directly from this repo, you'll need to make one change to your local environment, which is to remove the `/public` from your `.gitignore` file. This is because we don't install Grunt or its dependencies in production environments to make everything faster/easier for people who install Buckets as an NPM module.
# Documentation
### Developer Documentation
* [Config](docs/config.md)
* [Frontend Architecture](docs/frontend.md)
* [Database](docs/database.md)
* [Tests](docs/tests.md)
* [Plugins](docs/plugins.md)
* [REST API Docs](docs/api/)
### User Documentation
* [Routes](docs/user-docs/routes.md)
* [Templates](docs/user-docs/templates.md)
* [Design](docs/user-docs/design.md)
# Community
Follow along with Buckets’ progress and keep in touch with other Buckets users.
* Follow Buckets on [Twitter](http://twitter.com/bucketsio) and [Facebook](http://facebook.com/bucketsio)
* Keep up to date with [announcements](https://assembly.com/buckets/posts/) and track [project progress](https://assembly.com/buckets/wips) on Assembly.
* [Sign up](http://buckets.io) to be notified when Buckets is available for public beta.
### Contributing
This is a product being built by the [Assembly](https://assemblymade.com) community. You can help push this idea forward by visiting [https://assemblymade.com/buckets](https://assemblymade.com/buckets). We welcome any contributions to product design/direction or code.
Assembly products are made with contributions from the community. Assembly handles the boring stuff like hosting, support, financing, legal, etc. Once the product launches we collect the revenue and split the profits amongst the contributors.