diff -r 819a7ab4e3fb -r 5847345004db README.md --- a/README.md Mon Sep 17 15:32:33 2018 +0200 +++ b/README.md Mon Sep 17 17:38:24 2018 +0200 @@ -1,6 +1,7 @@ # Annotation Dashboard -This repository contains rthe code for IRI annotations dashboards. +This repository contains the code for IRI annotations dashboards. +This repository contains all the instance of the dashboard and the commion components. ## Getting Started @@ -18,11 +19,6 @@ - node and npm/npx - -``` -Give examples -``` - ### Init env #### ClientJS @@ -30,78 +26,74 @@ - `cd clientjs` - `npm install` - `npx lerna bootstrap` -- `cp packages/annotation-dashboard-explorunivers/.env packages/annotation-dashboard-explorunivers/.env.production` -- Edit the file `packages/annotation-dashboard-explorunivers/.env.production` +- `cp packages/annotation-dashboard-explorunivers/.env-tmpl packages/annotation-dashboard-explorunivers/.env.development` +- Edit the file `packages/annotation-dashboard-explorunivers/.env.development` - `npx lerna run build` -### Installing +### Setup dev environment -A step by step series of examples that tell you how to get a development env running - -Say what the step will be +#### setup Server -``` -Give the example -``` - -And repeat +##### isso +Utilise pipenv : https://github.com/pypa/pipenv -``` -until finished -``` - -End with an example of getting some data out of the system or using it for a little demo +- `cd server/isso/` +- configure isso +- `cp isso.cfg.tmpl isso.cfg` +- `pipenv install` +- `pipenv run isso -c ./isso.cfg run` -## Running the tests - -Explain how to run the automated tests for this system +##### Annotation proxy +- `cd server/sbin/` +- `cp hypothesis_proxy.conf.tmpl hypothesis_proxy.conf` +- configure proxy +- `pipenv install` +- `pipenv run python ./hypothesis_proxy.py` -### Break down into end to end tests - -Explain what these tests test and why +#### setup client js -``` -Give an example -``` +- `cd clientjs` +- `npm install` +- `cp packages/annotation-dashboard-explorunivers/.env-tmpl packages/annotation-dashboard-explorunivers/.env.development` +- configure .env.development file +- `npx lerna bootstrap` -### And coding style tests +##### build dashboard-components -Explain what these tests test and why +- `cd packages/dashboard-components` +- `npm run start` -``` -Give an example -``` +##### build annotation-dashboard-explorunivers + +- `cd packages/annotation-dashboard-explorunivers` +- `npm run start` + ## Deployment -Add additional notes about how to deploy this on a live system +The Deployment use Ansble script. +The process is described in the [deploy/README.md](deploy/README.md) file. ## Built With -* [Dropwizard](http://www.dropwizard.io/1.0.2/docs/) - The web framework used -* [Maven](https://maven.apache.org/) - Dependency Management -* [ROME](https://rometools.github.io/rome/) - Used to generate RSS Feeds +* [React.js](https://reactjs.org/) - The JS framework used +* [Redux](https://redux.js.org/) - Datastore management +* [Bootstrap](https://getbootstrap.com/) - CSS Framework +* [Isso](https://posativ.org/isso/) - Used for discussion threads +* [Webpak](https://webpack.js.org/) - Js Bundler +* [Lerna](https://lernajs.io/) - Lerna for packages managements +* [Ansible](https://www.ansible.com/) - Ansible for deployment -## Contributing - -Please read [CONTRIBUTING.md](https://gist.github.com/PurpleBooth/b24679402957c63ec426) for details on our code of conduct, and the process for submitting pull requests to us. ## Versioning We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/your/project/tags). -## Authors - -* **Billie Thompson** - *Initial work* - [PurpleBooth](https://github.com/PurpleBooth) - -See also the list of [contributors](https://github.com/your/project/contributors) who participated in this project. ## License -This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details +This project is licensed under the CeCILL-C - see the [LICENSE.md](LICENSE.md) file for details ## Acknowledgments -* Hat tip to anyone whose code was used -* Inspiration -* etc +* Thank you