README.md

Colorbucket Main API

API to persist and sync across devices your loved colors!

Write in Node.js + express + es6 and with the main database repository being on MongoDB, this API will fill the bucket with your loved colors.

How it works?

Check out the about page: http://colorbucket.co/about

Running locally

Install Global Dependancies

• Node.js
• MongoDb

Running the project

• start mongo server mongod
• git clone https://github.com/ColorBucket/colorbucket-api.git
• cd to project folder
• run npm install
• run npm start to start the API server

Under the hood?

• Node.js
• + express
• + es6
• + mongoose
• + promises(bluebird)
• + param validation(Joi)
• Unit testing (to-do)
• Dockerfile (to-do)
• Jenkins CI+CD (to-do)

Made with ❤️ by Gabriel "Age"