ChristianMurphy / nicest

nicely integrating complex education software together
MIT License
2 stars 3 forks source link
academic automation education github-api hapi javascript mongoose nodegit pm2 pug semantic-ui

nicest

npm version Build Status Dependency Status devDependency Status

Built with Hapi Semver Conventional Commits MIT license

nicely integrating complex education software together

About

Nicest is a setup tool for software educators. For the alpha version of the project, the focus is on agile software development tools. The system is currently able to setup Github source control, Taiga taskboard, and CIAssess continuous project assessment. In the future Nicest will add support for more tools, and integrations between tools.

Installation

  1. Install Node JS version 8
  2. Install Mongo Db version 3
  3. Install Node Gyp
  4. Run npm install -g nicest

Setup

  1. Create a Github account (an existing account can also be used)

  2. Register nicest as an application

    • 'Application Name', 'Homepage URL', and 'Application Description' can be anything
    • 'Authorization callback URL' must be the Host name or IP address of your computer/server
    • E.G. 'Authorization callback URL' could be 'example.com/login', 'localhost:3000/login' or '11.11.11.11/login'
    • After creating the application be sure to copy down the client id and secret token
  3. Run nicest init to configure nicest

  4. Run nicest user to create an admin

Start

  1. Run nicest start

Stop

  1. Run nicest stop

Additional Guides

Tasks

Tasks can be run from a Terminal or Command Line using nicest <task>