Giter VIP home page Giter VIP logo

openlmis-auth-ui's Introduction

OpenLMIS Auth-UI

This repository is the UI for the OpenLMIS Auth Service.

Prerequisites

  • Docker 1.11+
  • Docker Compose 1.6+

Quick Start

  1. Fork/clone this repository from GitHub.
> git clone https://github.com/OpenLMIS/openlmis-auth-ui.git
> cd openlmis-auth-ui/
  1. Create a .env file, which can be used to overwrite 'sensitive' settings from config.json
> touch .env
  1. Develop w/ Docker by running docker-compose run --service-ports auth-ui.
  2. You should now be in an interactive shell inside the newly created development environment, build the project with:
$ npm install // installs the NodeJS tools

$ grunt --serve
// or
$ grunt clean bower build --serve
  1. Go to http://localhost:9000/webapp/ to see the login page.

Note: To change the location of where the OpenLMIS-UI attemps to access OpenLMIS, use the command grunt build --serve --openlmisServerURL=<openlmis server url>.

Building & Testing

See the OpenLMIS/dev-ui project for more information on what commands are available, below are the command you might use during a normal work day.

// Open docker in an interactive shell
> docker-compose run --service-ports auth-ui

// Install dependencies 
$ npm install
$ grunt clean
$ grunt bower

// Build and run the UI against a OpenLMIS server
$ grunt build --serve --openlmisServerURL=<openlmis server url>

// Run unit tests
$ grunt karma:unit

// Run a watch process that will build and test your code
// NOTE: You must change a file at least once before your code is rebuilt
$ grunt watch --serve --openlmisServerURL=<openlmis server url>

Built Artifacts

After the OpenLMIS-UI is built and being served, you can access the following documents:

  • http://localhost:9000/webapp/ The compiled OpenLMIS application
  • http://localhost:9000/docs/ JS Documentation created from the source code
  • http://localhost:9000/styleguide/ KSS Documentation created from the CSS

Build Deployment Image

The specialized docker-compose.builder.yml is geared toward CI and build servers for automated building, testing and docker image generation of the UI module.

> docker-compose pull
> docker-compose run --entrypoint ./build.sh auth-ui
> docker-compose build image

Internationalization (i18n)

Transifex has been integrated into the development and build process. In order to sync with the project's resources in Transifex, you must provide values for the following keys: TRANSIFEX_USER, TRANSIFEX_PASSWORD.

For the development environment in Docker, you can sync with Transifex by running the sync_transifex.sh script. This will upload your source messages file to the Transifex project and download translated messages files.

The build process has syncing with Transifex seamlessly built-in.

openlmis-auth-ui's People

Contributors

anawrotsoldevelo avatar as588 avatar benleibert avatar brandonbowersox avatar chunky56 avatar corson avatar dariapionk avatar jakubjakubowskisoldevelo avatar jkondrat avatar joshzamor avatar koch0142 avatar kpalkowska avatar krzysieksold avatar mdulko avatar mgrochalskisoldevelo avatar mikolajbassoldevelo avatar mkwiatkowskisoldevelo avatar ngraczewski avatar nickdotreid avatar nikolalaskowska avatar olewandowski1 avatar p-pinker avatar pawelcieszko avatar pbuzderewicz avatar pgesek avatar pmuchowski avatar saleksandra avatar sebbrudzinski avatar sniedzielski avatar squtis1 avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  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.