ukhomeoffice / removals_wallboard

Wall board for removal project

Removals Wallboard

Quickstart:

Get NodeJS via nvm

$ curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.31.0/install.sh | bash

Install NodeJS 4 LTS

$ nvm install 4
$ nvm use 4

Build:

$ npm install

Test:

$ npm test

CI Test:

$ npm test

Start development service using localhost keycloak and localhost backend

$ npm start

Build service to localhost

$ npm run build

Environment variables

VAR	OPTION	RESULT
BACKEND	[string]	backend to use
KEYCLOAKURL	[string]	keycloak login url
CLIENTID	[string]	keycloak client id
KEYCLOAKACCOUNTSERVICE	[string]	url to use for managing the user's keycloak account
PORT	[integer]	port to run nginx server on

Docker

Can be built and run in the same way with docker for example:

$ docker build -t ibm-frontend .
$ docker run -i -e "BACKEND=localhost:8000" ibm-frontend

removals_wallboard's Issues

Missing a License

Without a license a user cannot use a project as they might be sued! See here for a guide: https://gist.github.com/PurpleBooth/6f1ba788bf70fb501439, and here for an example https://github.com/nevir/readable-licenses/tree/master/markdown

Missing Good Readme

A project is useless without a good readme. See here for a guide: https://gist.github.com/PurpleBooth/6f1ba788bf70fb501439, and here for an example https://gist.github.com/PurpleBooth/109311bb0361f32d87a2

Missing a travis ci config

Make life easier for people submitting code to your repository. Make sure that you double check that their code works the best you can (even if that's just running a build of the package) in travis. This way potential contributors can fix bugs before you even need to look at their request. https://gist.github.com/PurpleBooth/6f1ba788bf70fb501439

Missing a CONTRIBUTING file

A contributing file is a place for a user to work out how to contribute to a project, and what coding standards, and things they need to do before submitting code. It is also the place you should include a code of conduct, to make sure people know they can be expected to be treated fairly by the project. https://gist.github.com/PurpleBooth/6f1ba788bf70fb501439