https://github.com/christianmurphy/nicest

nicely integrating complex education software together
https://github.com/christianmurphy/nicest

academic automation education github-api hapi javascript mongoose nodegit pm2 pug semantic-ui

Last synced: 2 months ago
JSON representation

nicely integrating complex education software together

• Host: GitHub
• URL: https://github.com/christianmurphy/nicest
• Owner: ChristianMurphy
• License: mit
• Created: 2015-06-27T04:12:12.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2024-05-16T19:38:48.000Z (7 months ago)
• Last Synced: 2024-05-16T20:32:26.909Z (7 months ago)
• Topics: academic, automation, education, github-api, hapi, javascript, mongoose, nodegit, pm2, pug, semantic-ui
• Language: JavaScript
• Homepage:
• Size: 1.32 MB
• Stars: 2
• Watchers: 6
• Forks: 3
• Open Issues: 31
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# nicest

[![npm version](https://img.shields.io/npm/v/nicest.svg)](https://www.npmjs.com/package/nicest)

[![Build Status](https://travis-ci.org/ChristianMurphy/nicest.svg?branch=master)](https://travis-ci.org/ChristianMurphy/nicest)

[![Dependency Status](https://david-dm.org/ChristianMurphy/nicest.svg)](https://david-dm.org/ChristianMurphy/nicest)

[![devDependency Status](https://david-dm.org/ChristianMurphy/nicest/dev-status.svg)](https://david-dm.org/ChristianMurphy/nicest?type=dev)

[![Built with Hapi](https://img.shields.io/badge/built_with-hapi-blue.svg)](https://hapijs.com/)

[![Semver](http://img.shields.io/SemVer/2.0.0.png)](http://semver.org/spec/v2.0.0.html)

[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg)](https://conventionalcommits.org)

[![MIT license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/ChristianMurphy/nicest/master/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](https://en.wikipedia.org/wiki/Agile_software_development).

The system is currently able to setup [Github](https://github.com/) source control, [Taiga](https://taiga.io/)

taskboard, and [CIAssess](https://github.com/kgary/CIAssess) continuous project assessment.

In the future Nicest will add support for more tools, and integrations between tools.

## Installation

1.  Install [Node JS](https://nodejs.org/) version 8

2.  Install [Mongo Db](https://www.mongodb.org/) version 3

3.  Install [Node Gyp](https://github.com/nodejs/node-gyp#installation)

4.  Run `npm install -g nicest`

## Setup

1.  Create a [Github account](https://github.com/) (an existing account can also be used)

2.  [Register nicest](https://github.com/settings/applications/new) 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

*   [Contributing](CONTRIBUTING.md)

*   [Plugin](PLUGIN.md)

## Tasks

Tasks can be run from a Terminal or Command Line using `nicest `

*   `dev` developer server start

*   `init` creates a configuration file

*   `start` production server start

*   `stop` production server stop

*   `user` creates a new user