Giter Club home page Giter Club logo

cluedo's Introduction

cluedo-brainyfools

Do you want to play ?

Click here

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

You just need to be aware of using things like

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

Project Skeleton

Cluedo/
  ├─ logs/
  |   └─ *.log
  ├─ public/
  │   ├─ css/
  │   ├─ images/
  │   ├─ js/
  │   ├─ svg/
  │   ├─ *.html
  ├─ src/
  │   ├─ utils/
  │   ├─ routes/
  │   └─ models/
  ├─ templates/
  ├─ test/
  │   ├─ handler/
  │   ├─ integration/
  │   └─ models/
  │   ├─ utils/
  |
  ├─ app.js
  ├─ server.js
  ├─ .gitignore
  ├─ .eslintrc
  ├─ .npmrc
  ├─ .eslintignore
  ├─ README.md
  ├─ .editorconfig
  └─ package.json

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/cluedo-brainyfools.git
  1. Run executable file from your project root directory
$ sh bin/setup.sh
  1. Run tools file from your project root directory to install testing tools globally
$ sh bin/tools.sh
  1. To start the application run npm start
npm start

Contribution

After preparing development environment, select an 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.

cluedo's People

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.