/intranet-mobile

Time + attendance management

Primary LanguageHTMLMIT LicenseMIT

Contributors Forks Stargazers Issues MIT License


Intranet-mobile

A mobile port of the official CPNV intranet webapp.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Documentation
  6. Contributing
  7. License
  8. Contact

About The Project

Built With

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

NPM

  • Archlinux

    $ sudo pacman -S npm

  • Windows

    $ choco install npm

Installation

  1. Clone the repo

    $ git clone https://github.com/Thynkon/intranet-mobile.git

  2. Install dependencies

    $ cd intranet-mobile
$ npm install
$ npm install -g sass

  3. Compile scss files to css

    $ npm run css

NOTE - This only works on unix-like operating systems because npm will run a bash script.

If you are running windows type instead:

$ pip install -r requirements.txt
$ npm run css-windows

Usage

In case you want a live demo of this application, you can find it here.

Roadmap

See the open issues for a list of proposed features (and known issues).

Documentation

The documentation about the routing system, class diagrams, database model and the state diagram can be found under the doc/ folder:

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Project Link: https://github.com/Thynkon/intranet-mobile