Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dhis2/interpretation-app
DHIS 2 interpretation app
https://github.com/dhis2/interpretation-app
synced-settings tx web-app
Last synced: 10 days ago
JSON representation
DHIS 2 interpretation app
- Host: GitHub
- URL: https://github.com/dhis2/interpretation-app
- Owner: dhis2
- Created: 2016-09-28T12:22:35.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2024-10-28T11:35:48.000Z (21 days ago)
- Last Synced: 2024-10-28T14:59:08.532Z (21 days ago)
- Topics: synced-settings, tx, web-app
- Language: JavaScript
- Homepage:
- Size: 5.02 MB
- Stars: 2
- Watchers: 39
- Forks: 5
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
DHIS 2 Interpretation app
---
This repo contains the DHIS 2 interpretation wall app.
## Prerequisites
Make sure you have at least the following versions of `node` and `npm`.
+ Node version v5.6.0 or higher
+ npm version 3.8.0 or higher
Use the following commands to check your current versions
```sh
node -v
npm -v
```
## Getting started
Clone the repository from github with the following command
```sh
git clone https://github.com/dhis2/interpretation-app
```
Install the node dependencies
```sh
npm install
```
To set up your DHIS2 instance to work with the development service you will need to add the development servers address to the CORS whitelist. You can do this within the DHIS2 Settings app under the _access_ tab. On the access tab add `http://localhost:8081` to the CORS Whitelist.
> The starter app will look for a DHIS 2 development instance configuration in
> `$DHIS2_HOME/config`. So for example if your `DHIS2_HOME` environment variable is
> set to `~/.dhis2`, the starter app will look for `~/.dhis2/config.js` and then
> `~/.dhis2/config.json` and load the first one it can find.
>
> The config should export an object with the properties `baseUrl` and
> `authorization`, where authorization is the base64 encoding of your username and
> password. You can obtain this value by opening the console in your browser and
> typing `btoa('user:pass')`.
>
> If no config is found, the default `baseUrl` is `http://localhost:8080/dhis` and
> the default username and password is `admin` and `district`, respectively.
>
> See `webpack.config.js` for details.
This should enable you to run the following node commands:
To run the development server
```sh
npm start
```
To run the tests one time
```sh
npm test
```
To run the tests continuously on file changes (for your BDD workflow)
```sh
npm run test-watch
```
To generate a coverage report for the tests
```sh
npm run coverage
```
To check the code style for both the JS and SCSS files run
```sh
npm run lint
```
# Tools
## Frameworks and libraries
### React
[React](https://facebook.github.io/react/) is the _view_ part of the front-end applications, it has a component based architecture. At DHIS2 we also use JSX syntax that is generally used with React.
###d2, d2-ui
[d2](https://github.com/dhis2/d2) is the DHIS2 abstraction library that allows you to communicate with the DHIS2 api in a programatic way. [d2-ui](https://github.com/dhis2/d2-ui) is the ui component library that is build on top of d2 to allow reuse of common components that are used within DHIS2 applications. d2-ui also contains our own application wiring code through its _stores_ and _actions_.
### material-ui
d2-ui makes use of [material-ui](http://www.material-ui.com) for rendering more basic components like TextFields and Lists. It is therefore quite useful to look into this library too when building DHIS2 apps and making use of d2-ui.
## Workflow
### Webpack
Webpack is a module bundler that allows the use of plugins to do various other things. We make use of webpack for the following things:
+ Bundling the files up into a single file. (The primary webpack use case)
+ Transpiling ES2015 and React JSX code to ES5 syntax so it runs in the browser. (This is done using [Babel](http://babeljs.io).)
+ Loading [Scss](http://sass-lang.com) files. Scss is a css pre-processor that has quite some fancy features as variables, nesting of style declarations etc.
+ Minifying the bundled file to reduce file size
+ Remove duplicate dependencies
To make the development a more interactive experience we use `webpack-dev-server` to provide us with a development server that watches the project files and refreshes the browser when changes are detected.
### npm
[Npm](https://www.npmjs.com) is used as both a dependency management tool as a _workflow manager_ through its `scripts` as can be seen in the [package.json](https://github.com/dhis2/interpretations-app/blob/master/package.json#L6-L14). It provides convenience commands to kick off various tasks. These tasks are mentioned above as `npm run `, `npm start`, `npm test`, etc.
### linting
To make sure the code is in line with the code style, we use [eslint](http://eslint.org) as a static style checker. To a large degree we follow the [airbnb Javascript styleguide](https://github.com/airbnb/javascript). We do however have slight modifications which are defined in our own eslint-config. ([eslint-config-dhis2](https://github.com/dhis2/eslint-config-dhis2/blob/master/.eslintrc))
## Testing
### mocha, chai, sinon
[Mocha](https://mochajs.org) is a test runner that runs the unit tests. [Chai](http://chaijs.com) is the assertion library that is used to do assertions within those tests. It supports various styles. At DHIS2 we generally tend to go with the [expect/BDD](http://chaijs.com/api/bdd/) variant. [Sinon](http://sinonjs.org) is used to do mocking within the tests and to fake HTTP requests where needed. The interesting things to look at for sinon are it's [spies](http://sinonjs.org/docs/#spies) and [stubs](http://sinonjs.org/docs/#stubs) calls and the [fakeServer](http://sinonjs.org/docs/#fakeServer).
### enzyme
[Enzyme](https://github.com/airbnb/enzyme) tool to make testing of React components easier. They provide a pretty clean api to get information from your rendered react components.