Code Monkey home page Code Monkey logo

hesabu-manager's Introduction

Bluesquare hesabu manager

https://github.com/BLSQ/hesabu-manager/workflows/Build%20and%20publish%20to%20s3%20bucket/badge.svg Maintainability

Is a dhis2 (react) app to manage a blsq hesabu project. It connects to the Hesabu api and allows you to manage your Hesabu from within DHIS2.

It will become the new frontend to the existing Hesabu API project. While the Hesabu API rails views are not going away, this will serve as more user friendly way to configure a Hesabu project.

Other apps repos:

Development

create a .env

.env to point to a prod dhis2 and prod hesabu api

REACT_APP_DHIS2_URL=
REACT_APP_USER=
REACT_APP_PASSWORD=

.env to point to a prod dhis2 and local hesabu api

REACT_APP_DHIS2_URL=
REACT_APP_USER=
REACT_APP_PASSWORD=

REACT_APP_API_URL=http://localhost:3001/api
REACT_APP_API_TOKEN=<<your_project_token>>

.env to point to a play dhis2 and mock hesabu api

REACT_APP_DHIS2_URL=https://play.dhis2.org/2.30
REACT_APP_USER=admin
REACT_APP_PASSWORD=district

REACT_APP_API_URL=http://localhost:4567/api
REACT_APP_API_TOKEN=<<unused>>

Don't forget to start the mock server (ruby required)

cd ../mock-server
bundle install
bundle exec ruby app.rb

Getting started

Run the app. This a CRA app, so all standard commands works as expected.

yarn start

Committing

This project uses automated semantic versionning based on commit messages or PR titles. Everything you want to appear in the CHANGELOG.md file please consider using this commit message formatting:

feat: A new feature
fix: A bug fix
docs: Documentation only changes
style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
refactor: A code change that neither fixes a bug nor adds a feature
perf: A code change that improves performance
test: Adding missing or correcting existing tests
chore: Changes to the build process or auxiliary tools and libraries such as documentation generation

Formatting/linting

By default there is a pre-commit hook (provided by husky) that will run prettifier-eslint.

If you want to avoid this hook, run with HUSKY_SKIP_HOOKS=1, and run yarn format yourself.

Deploy

  • except for debugging purpose don't deploy individually, or from your laptop.
  • the cra app is build based on the development branch by github actions and published to s3
  • the deployment of this s3 artefact is done via a rake task in the orbf2 repository to target all the dhis2 configured in the database.

hesabu-manager's People

Contributors

borisrorsvort avatar mestachs avatar semantic-release-bot avatar dependabot[bot] 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.