Comic Headquarters

The webcomic plataform

Dependencies

• Node.js 0.10+
• MongoDB
• Redis Server

Use Docker to handle dependencies

The project has a docker-compose.yml to run MongoDB and Redis as services. This is the easiest way to have the app running.

First install Docker and Docker Compose.

Then run (first time).

docker-compose pull
docker-compose up -d

Check this other commands

# start services (after first run with up)
docker-compose start

# stop services
docker-compose stop

# check status
docker-compose ps

Running

First, copy config/local.example.js to config/local.js and change it as necessary.

Then run:

npm install
npm start

Run tests

npm test

Contributing guidelines

1. Use .editorconfig
2. Use CoffeeLint and jshint as Linters
3. Do not commit on master branch. Make a Fork and open pull-requests
4. Name branches as feature/changes. Ex.: user/twitter-auth
5. Write tests for every new feature

If needing in help contact the owners or open an Issue.