Skip to content

Guide

Jump to bottom
anujachaitanya edited this page Mar 4, 2020 · 9 revisions

Settlers Of Catan

Welcome, we are happy to see you here. We request you to read all the guidelines before contributing.

Tables of contents

Prerequisites

  • Node
  • Express
  • Cookie-parser
  • Mocha
  • Supertest
  • Chai

Project Skeleton 

SoftwareSamurai-settlers/
├─ public/
│  ├─ css/
│  ├─ assets/
│  ├─ js/
│  └─ *.html
├─ src/
│  ├─ handlers/
│  ├─ app.js
│  └─ models/
├─ bin/
│  └─ setup.sh
├─ .github/
│  ├─ commit-template
│  ├─ pre-push-hook.sh
│  └─ pre-commit-hook.sh
├─ test/
│  ├─ integration/
│  └─ unit/
├─ templates/
│  └─ *.html
├─ .gitignore
├─ .eslintrc
├─ README.md
├─ package.json
├─ package-lock.json
└─ server.js

Setup for development

To contribute to our project, Please proceed as follows.

  1. Clone the repository.
> git clone https://github.com/step-batch-7/softwareSamurai-settlers.git
  1. Run setup file from project root directory
> softwareSamurai-settlers$ bin/setup.sh
  1. To run the application
> softwareSamurai-settlers$ npm start

- By Software Samurai

Clone this wiki locally