A fast, simple way to build dynamic websites on top of Express, MongoDB, and ElasticSearch. More about our vision.

Installing Buckets

There are several ways to install Buckets. Choose the path which is the easiest fit for your development environment.

Heroku

The easiest way currently is to install on Heroku—as long as you have a Heroku account, you can simply use the button below:

NPM

To use Buckets directly from NPM, use:

npm install buckets --save

To add Buckets to your package.json. From here, you can run Buckets in your script like so:

buckets = require('buckets');
buckets({
  templatePath: __dirname + “/templates/“,
  publicPath: __dirname + “/public/“,
  // Additional configuration…
});

Note: We aim to provide separate middleware to build into existing Express apps soon.

From this repo

If you plan on contributing to Buckets' development, you can install Buckets directly from this repo.

Pre-requirements

MongoDB, Node.js and the following global:

npm install -g grunt-cli

Then install the local Node dependencies:

npm install

At this point, you should be able to run:

grunt serve

After building, Buckets should then be accessible at the default address: http://localhost:3000/. If you plan on working on Buckets source, you should check out the other grunt tasks available for dev and test commands.

Documentation

Developer Documentation

• Frontend Architecture
• Database
• Tests
• Migrations
• Deploying to Heroku

User Documentation

• Routes
• Templates

Community

Follow along with Buckets’ progress and keep in touch with other Buckets users.

• Follow Buckets on Twitter and Facebook
• Keep up to date with announcements and track project progress on Assembly.
• Sign up to be notified when Buckets is available for public beta.

Contributing

This is a product being built by the Assembly community. You can help push this idea forward by visiting 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.