node-timelord

NodeJS implementation of Timelord

How to run

See the wiki for info about the deployment on URY.

Docker

docker compose up --build

Will build the docker image

docker compose up -d

Can then be used to run the container in the background, by default using port 8000

Development

$ git clone https://github.com/UniversityRadioYork/node-timelord/
$ cd node-timelord
$ npm install # you should only need to run this once
$ grunt
# browse to localhost:8000 to see it
# any changes to files in `src/` will be compiled and the browser will automatically reload 

Production

Deployment on URY is handled by Jenkins. Use the node-timelord and node-timelord-staging jobs to deploy the master branch. See the wiki for more about deployment on URY.

Manual instructions

You will need some kind of way of serving static files from the /bin folder. I.E. Apache, Nginx etc.

$ git clone https://github.com/UniversityRadioYork/node-timelord/
$ cd node-timelord
$ npm install # you should only need to run this once
$ grunt build #will compile all files needed into /bin/

If you want to do a development build without clearing out /bin then run grunt build:noclean instead.

Dependencies

http://expressjs.com

• grunt: The JavaScript Task Runner
• grunt-contrib-connect: Start a connect web server
• grunt-contrib-uglify: Minify files with UglifyJS
• grunt-contrib-watch: Run predefined tasks whenever watched file patterns are added, changed or deleted.
• grunt-sass: Compile Sass to CSS using node-sass
• grunt-wiredep: Inject your Bower dependencies right into your HTML from Grunt.
• serve-static: Serve static files

Global Dependencies

• grunt-cli: Grunt's command line interface. http://gruntjs.com/
• bower: A package manager for the web

Dev Dependencies

Use npm install --dev to get the following for deployment:

• flightplan: A library for streamlining application deployment or systems administration tasks

License

ISC

Generated by package-json-to-readme