Giter Club home page Giter Club logo

chkr's Introduction

CHKR

A minimalist checklist web application built on the MEAN stack.

Offers users simple tracking of both daily tasks and longer-term to-dos.

Features:

  • A clean, responsive interface facilitated by Angular & Bootstrap.
  • A simple API for managing users and their tasks.
  • A coloring system for task organization.
  • Automated reset of daily tasks and purging of completed to-dos.
  • A fully automated build & test system through Grunt and Karma.js.
  • A robust and secure MongoDB database for user information.

Setup

CHKR is designed to be easy to deploy on any Linux system. Production and development environments require standard MongoDB and NodeJS installations. Also required are:

Ruby: sudo apt-get install ruby-full Sass: sudo su -c "gem install sass" Grunt: npm install -g grunt-cli

Run npm install and bower install to collect the necessary server-side and client-side packages, respectively.

Running

Building, testing, and running CHKR is accomplished easily with Grunt. Simply issue the command grunt from the top level of the CHKR directory to build and test your version.

If everything builds properly, a development server may be started with grunt serve. This serves the un-optimized files out of client/app to port 9000 (unless another port has been specified in your Node environment.)

Grunt builds the production version of the application in /dist. To serve these files, run NODE_ENV=production npm start or a similar command in /dist.

Development

The current release version of CHKR is maintained on branch master. Pushes to this branch should be restricted to critical bugfixes.

Feature development should be done on branch development. Further sub-branches may be forked and merged into development as needed.

chkr's People

Watchers

James Cloos avatar Sean McGrath avatar Santiago avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.