Merge pull request #6 from EyeSeeTea/development

Release 2.1.0

.env

@@ -0,0 +1,4 @@
+HOST=localhost
+PORT=8002
+REACT_APP_DHIS2_BASE_URL="http://localhost:8080"
+REACT_APP_DHIS2_AUTH="admin:district"

.gitignore

@@ -1,5 +1,47 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+assets/includes/*
+
+# testing
+/coverage
+
+# production
+manifest.webapp
+/build
+
+# misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+*.sublime-project
+*.sublime-workspace
+*.code-workspace
+*.zip
+.tern-project
 .project
 .settings
-.tern-project
-*.zip
-.idea
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+src/locales/
+src/react-app.d.ts
+src/react-app-env.d.ts
+bak
+.eslintcache
+
+# cypress
+cypress/screenshots/
+cypress/videos/
+cypress/fixtures/
+
+# IntelliJ
+.idea/*
+
+# VS Code
+.vscode/*

.prettierignore

@@ -0,0 +1,5 @@
+build
+assets
+node_modules
+*.min.js
+*.min.css

.prettierrc

@@ -1,4 +1,13 @@
 {
-  "tabWidth": 4,
-  "useTabs": true
+    "printWidth": 120,
+    "tabWidth": 4,
+    "useTabs": false,
+    "semi": true,
+    "singleQuote": false,
+    "trailingComma": "es5",
+    "bracketSpacing": true,
+    "arrowParens": "avoid",
+    "proseWrap": "preserve",
+    "requirePragma": false,
+    "insertPragma": false
 }

README.md

@@ -1,2 +1,26 @@
-# tally_sheets
-Tally Sheets
+# Tally Sheets
+
+## Setup and Installation
+Build the app running:
+
+```console
+shell:~$ yarn install # first time only
+shell:~$ yarn build
+```
+This will create a `hmis-tally-sheets.zip` file that can be manually installed in DHIS2 App Management.
+
+## Development
+
+The above mentioned method of deploying the app is not suited for development. To deploy a local instance of the app use:
+```console
+shell:~$ yarn start
+```
+
+This deploys a [http-server](https://github.com/http-party/http-server) serving the app with a proxy to the DHIS2 instance to serve the DHIS2 API calls.
+The `yarn start` command reads the variables present in `.env.local` to start the local server. Use `.env` as a template to create it.
+
+## Development environment building
+
+The app dependencies in `assets/includes` has been migrated to `yarn` using `yarn info <package>@<ver> repository` to compare the repositories mentioned in the old files and the ones from Yarn to ensure we get the correct ones. Some files needed to be cross-checked to ensure thy were the same.
+
+The `build-deps.sh` script is used as a postinstall script to make a copy of the necessary files to the `assets/includes` folder to avoid uploading unnecessary files with the app build zip file.