Skip to content

Latest commit

 

History

History
116 lines (78 loc) · 3.27 KB

README.md

File metadata and controls

116 lines (78 loc) · 3.27 KB
Raw

Carcassonne Scoreboard (client)

Build Status Commitizen friendly

Live version running at: carcassonne.sonnywebdesign.com

Install

Introduction

Because this repository consists in the client side of the application only, if you want to run the whole application in your own local environment, you will need to download and run the server side first.

Prepare your local environment

Get the code

First clone this repo to your local machine with:

git clone https://github.com/andreasonny83/carcassonne-scoreboard-client.git

Then, cd inside the project folder with:

cd !$

Install the dependencies

This project uses NodeJS, npm Bower and Gulp. Make sure you have them installed on your machine before proceeding.

Then, install all the project's dependencies

$ npm install
# Or Yarn for a faster installation
$ yarn install

This will install all the local dependencies the application needs to run in development mode.

Run your local project

If you have correctly installed all the dependencies, you will now be able to run your local project simply with:

npm start

from inside the main carcassonne-scoreboard-client folder, this command will trigger a gulp task responsible for initiate a local version of the application and open a new tab in your browser to render the localhost:5000 where the application will be rendered.

Configure the server side

The default server app is supposed to respond at: http://localhost:3000 however, if you want to use a different address to host your server app, you can either use environment variables or manually update the api.js file stored inside your server/ folder

Environment variables

API_URL: The API address for your client application (default is `http://localhost`)
API_PORT: The API port number for your client application (default is `5000`)
DEBUG: Enable/disable debug messages (default is `false`)

Build a minified distribution version

npm run build

If present, gulp usemin will overwrite a client/app/config.dist.js with client/app/config.js during the build and deploy tasks. In this way you can simply clone your client/app/config.js to a new client/app/config.dist.js in where storing your production information.

Serve from the distribution folder

npm run serve:dist

This task will generate a new distribution project and will serve that using local server.

Contributing

We really appreciate your collaborations and feedbacks!

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Stage your files: git add .
  4. Commit your changes: npm run commit
  5. Push to the branch: git push origin my-new-feature
  6. Submit a pull request :D

Changelog

Changelog available here

License

MIT © Andrea Sonny