acquire-legends

Click here for demo

Contributing guidelines

Welcome buddy, We are happy to see you here. We request you to read all guides before contributing.

For styling guide click here

Table of Contents

• Prerequisites
• Project Skeleton
• Setup for development
• Contribution

Prerequisites

You just need to be aware of using below things

• Node
• ExpressJs
• AJAX
• Mocha
• Chai
• Supertest

Project Skeleton

Acquire/
├─ public/
│  ├─ css/
│  ├─ js/
│  ├─ assets/
│  └─ *.html
├─ src/
│  ├─ handlers/
│  └─ models/
├─ test/
│  ├─ helpers/
│  ├─ integration/
│  ├─ unit/
│  └─ functional/
├─ templates/
├─ logs/
│  └─  *.log
├─ .gitignore
├─ .jshintc
├─ .eslintrc
├─ README.md
├─ .editorconfig
├─ package.json
└─ setup.sh

Setup for development

To contribute for this project you need to do the following things.

1. clone the repository

> git clone https://github.com/step-tw/acquire-legends

2. Run setup file from your project root directory

 ➜  acquire-legends$ bin/setup.sh

3. Run tools file from your project root directory to install testing tools globally

➜  acquire-legends$ bin/tools.sh

4. To start the application run npm start

 > npm start

Contribution

After preparing development environment , select a issue that you want to work on and assign it to yourself.

As a pair follow TDD write tests to cover every line of code you added.

Important

• Our tools file included editorconfig plugin for atom
  • for other editors please install editorconfig plugin for your editor
• Make sure your all log files are in logs directory and with extension .log