annotation-dashboard: README.md@eb14941af2e7 (annotated)

0 5f4fcbc80b37 Create new repository to host all dashboard developments ymh <ymh.work@gmail.com> parents: diff changeset	1	# Annotation Dashboard
5f4fcbc80b37 Create new repository to host all dashboard developments ymh <ymh.work@gmail.com> parents: diff changeset	2
7 5847345004db prepare project for first version ymh <ymh.work@gmail.com> parents: 0 diff changeset	3	This repository contains the code for IRI annotations dashboards.
5847345004db prepare project for first version ymh <ymh.work@gmail.com> parents: 0 diff changeset	4	This repository contains all the instance of the dashboard and the commion components.
0 5f4fcbc80b37 Create new repository to host all dashboard developments ymh <ymh.work@gmail.com> parents: diff changeset	5
5f4fcbc80b37 Create new repository to host all dashboard developments ymh <ymh.work@gmail.com> parents: diff changeset	6	## Getting Started
5f4fcbc80b37 Create new repository to host all dashboard developments ymh <ymh.work@gmail.com> parents: diff changeset	7
5f4fcbc80b37 Create new repository to host all dashboard developments ymh <ymh.work@gmail.com> parents: diff changeset	8	These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
5f4fcbc80b37 Create new repository to host all dashboard developments ymh <ymh.work@gmail.com> parents: diff changeset	9
5f4fcbc80b37 Create new repository to host all dashboard developments ymh <ymh.work@gmail.com> parents: diff changeset	10	### Prerequisites
5f4fcbc80b37 Create new repository to host all dashboard developments ymh <ymh.work@gmail.com> parents: diff changeset	11
5f4fcbc80b37 Create new repository to host all dashboard developments ymh <ymh.work@gmail.com> parents: diff changeset	12	### Prerequisites for server
5f4fcbc80b37 Create new repository to host all dashboard developments ymh <ymh.work@gmail.com> parents: diff changeset	13
5f4fcbc80b37 Create new repository to host all dashboard developments ymh <ymh.work@gmail.com> parents: diff changeset	14	- Python 3.7
5f4fcbc80b37 Create new repository to host all dashboard developments ymh <ymh.work@gmail.com> parents: diff changeset	15	- pipenv
5f4fcbc80b37 Create new repository to host all dashboard developments ymh <ymh.work@gmail.com> parents: diff changeset	16	- envrc
5f4fcbc80b37 Create new repository to host all dashboard developments ymh <ymh.work@gmail.com> parents: diff changeset	17
5f4fcbc80b37 Create new repository to host all dashboard developments ymh <ymh.work@gmail.com> parents: diff changeset	18	### Prerequisites for clientjs
5f4fcbc80b37 Create new repository to host all dashboard developments ymh <ymh.work@gmail.com> parents: diff changeset	19
5f4fcbc80b37 Create new repository to host all dashboard developments ymh <ymh.work@gmail.com> parents: diff changeset	20	- node and npm/npx
5f4fcbc80b37 Create new repository to host all dashboard developments ymh <ymh.work@gmail.com> parents: diff changeset	21
5f4fcbc80b37 Create new repository to host all dashboard developments ymh <ymh.work@gmail.com> parents: diff changeset	22	### Init env
5f4fcbc80b37 Create new repository to host all dashboard developments ymh <ymh.work@gmail.com> parents: diff changeset	23
5f4fcbc80b37 Create new repository to host all dashboard developments ymh <ymh.work@gmail.com> parents: diff changeset	24	#### ClientJS
5f4fcbc80b37 Create new repository to host all dashboard developments ymh <ymh.work@gmail.com> parents: diff changeset	25
5f4fcbc80b37 Create new repository to host all dashboard developments ymh <ymh.work@gmail.com> parents: diff changeset	26	- `cd clientjs`
5f4fcbc80b37 Create new repository to host all dashboard developments ymh <ymh.work@gmail.com> parents: diff changeset	27	- `npm install`
5f4fcbc80b37 Create new repository to host all dashboard developments ymh <ymh.work@gmail.com> parents: diff changeset	28	- `npx lerna bootstrap`
7 5847345004db prepare project for first version ymh <ymh.work@gmail.com> parents: 0 diff changeset	29	- `cp packages/annotation-dashboard-explorunivers/.env-tmpl packages/annotation-dashboard-explorunivers/.env.development`
5847345004db prepare project for first version ymh <ymh.work@gmail.com> parents: 0 diff changeset	30	- Edit the file `packages/annotation-dashboard-explorunivers/.env.development`
0 5f4fcbc80b37 Create new repository to host all dashboard developments ymh <ymh.work@gmail.com> parents: diff changeset	31	- `npx lerna run build`
5f4fcbc80b37 Create new repository to host all dashboard developments ymh <ymh.work@gmail.com> parents: diff changeset	32
7 5847345004db prepare project for first version ymh <ymh.work@gmail.com> parents: 0 diff changeset	33	### Setup dev environment
0 5f4fcbc80b37 Create new repository to host all dashboard developments ymh <ymh.work@gmail.com> parents: diff changeset	34
7 5847345004db prepare project for first version ymh <ymh.work@gmail.com> parents: 0 diff changeset	35	#### setup Server
0 5f4fcbc80b37 Create new repository to host all dashboard developments ymh <ymh.work@gmail.com> parents: diff changeset	36
7 5847345004db prepare project for first version ymh <ymh.work@gmail.com> parents: 0 diff changeset	37	##### isso
5847345004db prepare project for first version ymh <ymh.work@gmail.com> parents: 0 diff changeset	38	Utilise pipenv : https://github.com/pypa/pipenv
0 5f4fcbc80b37 Create new repository to host all dashboard developments ymh <ymh.work@gmail.com> parents: diff changeset	39
7 5847345004db prepare project for first version ymh <ymh.work@gmail.com> parents: 0 diff changeset	40	- `cd server/isso/`
5847345004db prepare project for first version ymh <ymh.work@gmail.com> parents: 0 diff changeset	41	- configure isso
5847345004db prepare project for first version ymh <ymh.work@gmail.com> parents: 0 diff changeset	42	- `cp isso.cfg.tmpl isso.cfg`
5847345004db prepare project for first version ymh <ymh.work@gmail.com> parents: 0 diff changeset	43	- `pipenv install`
5847345004db prepare project for first version ymh <ymh.work@gmail.com> parents: 0 diff changeset	44	- `pipenv run isso -c ./isso.cfg run`
0 5f4fcbc80b37 Create new repository to host all dashboard developments ymh <ymh.work@gmail.com> parents: diff changeset	45
7 5847345004db prepare project for first version ymh <ymh.work@gmail.com> parents: 0 diff changeset	46	##### Annotation proxy
5847345004db prepare project for first version ymh <ymh.work@gmail.com> parents: 0 diff changeset	47	- `cd server/sbin/`
5847345004db prepare project for first version ymh <ymh.work@gmail.com> parents: 0 diff changeset	48	- `cp hypothesis_proxy.conf.tmpl hypothesis_proxy.conf`
5847345004db prepare project for first version ymh <ymh.work@gmail.com> parents: 0 diff changeset	49	- configure proxy
5847345004db prepare project for first version ymh <ymh.work@gmail.com> parents: 0 diff changeset	50	- `pipenv install`
5847345004db prepare project for first version ymh <ymh.work@gmail.com> parents: 0 diff changeset	51	- `pipenv run python ./hypothesis_proxy.py`
0 5f4fcbc80b37 Create new repository to host all dashboard developments ymh <ymh.work@gmail.com> parents: diff changeset	52
7 5847345004db prepare project for first version ymh <ymh.work@gmail.com> parents: 0 diff changeset	53	#### setup client js
0 5f4fcbc80b37 Create new repository to host all dashboard developments ymh <ymh.work@gmail.com> parents: diff changeset	54
7 5847345004db prepare project for first version ymh <ymh.work@gmail.com> parents: 0 diff changeset	55	- `cd clientjs`
5847345004db prepare project for first version ymh <ymh.work@gmail.com> parents: 0 diff changeset	56	- `npm install`
5847345004db prepare project for first version ymh <ymh.work@gmail.com> parents: 0 diff changeset	57	- `cp packages/annotation-dashboard-explorunivers/.env-tmpl packages/annotation-dashboard-explorunivers/.env.development`
5847345004db prepare project for first version ymh <ymh.work@gmail.com> parents: 0 diff changeset	58	- configure .env.development file
5847345004db prepare project for first version ymh <ymh.work@gmail.com> parents: 0 diff changeset	59	- `npx lerna bootstrap`
0 5f4fcbc80b37 Create new repository to host all dashboard developments ymh <ymh.work@gmail.com> parents: diff changeset	60
7 5847345004db prepare project for first version ymh <ymh.work@gmail.com> parents: 0 diff changeset	61	##### build dashboard-components
0 5f4fcbc80b37 Create new repository to host all dashboard developments ymh <ymh.work@gmail.com> parents: diff changeset	62
7 5847345004db prepare project for first version ymh <ymh.work@gmail.com> parents: 0 diff changeset	63	- `cd packages/dashboard-components`
5847345004db prepare project for first version ymh <ymh.work@gmail.com> parents: 0 diff changeset	64	- `npm run start`
0 5f4fcbc80b37 Create new repository to host all dashboard developments ymh <ymh.work@gmail.com> parents: diff changeset	65
7 5847345004db prepare project for first version ymh <ymh.work@gmail.com> parents: 0 diff changeset	66	##### build annotation-dashboard-explorunivers
5847345004db prepare project for first version ymh <ymh.work@gmail.com> parents: 0 diff changeset	67
5847345004db prepare project for first version ymh <ymh.work@gmail.com> parents: 0 diff changeset	68	- `cd packages/annotation-dashboard-explorunivers`
5847345004db prepare project for first version ymh <ymh.work@gmail.com> parents: 0 diff changeset	69	- `npm run start`
5847345004db prepare project for first version ymh <ymh.work@gmail.com> parents: 0 diff changeset	70
0 5f4fcbc80b37 Create new repository to host all dashboard developments ymh <ymh.work@gmail.com> parents: diff changeset	71
11 37ecf0b9c174 Add Nextleap dashboard ymh <ymh.work@gmail.com> parents: 7 diff changeset	72	## Create new dashboard:
37ecf0b9c174 Add Nextleap dashboard ymh <ymh.work@gmail.com> parents: 7 diff changeset	73	- `cd annotation-dashboard/clientjs/packages`
37ecf0b9c174 Add Nextleap dashboard ymh <ymh.work@gmail.com> parents: 7 diff changeset	74	- `npx create-react-app --use-npm <new-dashboard>`
37ecf0b9c174 Add Nextleap dashboard ymh <ymh.work@gmail.com> parents: 7 diff changeset	75
0 5f4fcbc80b37 Create new repository to host all dashboard developments ymh <ymh.work@gmail.com> parents: diff changeset	76	## Deployment
5f4fcbc80b37 Create new repository to host all dashboard developments ymh <ymh.work@gmail.com> parents: diff changeset	77
7 5847345004db prepare project for first version ymh <ymh.work@gmail.com> parents: 0 diff changeset	78	The Deployment use Ansble script.
5847345004db prepare project for first version ymh <ymh.work@gmail.com> parents: 0 diff changeset	79	The process is described in the [deploy/README.md](deploy/README.md) file.
0 5f4fcbc80b37 Create new repository to host all dashboard developments ymh <ymh.work@gmail.com> parents: diff changeset	80
5f4fcbc80b37 Create new repository to host all dashboard developments ymh <ymh.work@gmail.com> parents: diff changeset	81	## Built With
5f4fcbc80b37 Create new repository to host all dashboard developments ymh <ymh.work@gmail.com> parents: diff changeset	82
7 5847345004db prepare project for first version ymh <ymh.work@gmail.com> parents: 0 diff changeset	83	* [React.js](https://reactjs.org/) - The JS framework used
5847345004db prepare project for first version ymh <ymh.work@gmail.com> parents: 0 diff changeset	84	* [Redux](https://redux.js.org/) - Datastore management
5847345004db prepare project for first version ymh <ymh.work@gmail.com> parents: 0 diff changeset	85	* [Bootstrap](https://getbootstrap.com/) - CSS Framework
5847345004db prepare project for first version ymh <ymh.work@gmail.com> parents: 0 diff changeset	86	* [Isso](https://posativ.org/isso/) - Used for discussion threads
5847345004db prepare project for first version ymh <ymh.work@gmail.com> parents: 0 diff changeset	87	* [Webpak](https://webpack.js.org/) - Js Bundler
5847345004db prepare project for first version ymh <ymh.work@gmail.com> parents: 0 diff changeset	88	* [Lerna](https://lernajs.io/) - Lerna for packages managements
5847345004db prepare project for first version ymh <ymh.work@gmail.com> parents: 0 diff changeset	89	* [Ansible](https://www.ansible.com/) - Ansible for deployment
0 5f4fcbc80b37 Create new repository to host all dashboard developments ymh <ymh.work@gmail.com> parents: diff changeset	90
5f4fcbc80b37 Create new repository to host all dashboard developments ymh <ymh.work@gmail.com> parents: diff changeset	91
5f4fcbc80b37 Create new repository to host all dashboard developments ymh <ymh.work@gmail.com> parents: diff changeset	92	## Versioning
5f4fcbc80b37 Create new repository to host all dashboard developments ymh <ymh.work@gmail.com> parents: diff changeset	93
5f4fcbc80b37 Create new repository to host all dashboard developments ymh <ymh.work@gmail.com> parents: diff changeset	94	We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/your/project/tags).
5f4fcbc80b37 Create new repository to host all dashboard developments ymh <ymh.work@gmail.com> parents: diff changeset	95
5f4fcbc80b37 Create new repository to host all dashboard developments ymh <ymh.work@gmail.com> parents: diff changeset	96
5f4fcbc80b37 Create new repository to host all dashboard developments ymh <ymh.work@gmail.com> parents: diff changeset	97	## License
5f4fcbc80b37 Create new repository to host all dashboard developments ymh <ymh.work@gmail.com> parents: diff changeset	98
7 5847345004db prepare project for first version ymh <ymh.work@gmail.com> parents: 0 diff changeset	99	This project is licensed under the CeCILL-C - see the [LICENSE.md](LICENSE.md) file for details
0 5f4fcbc80b37 Create new repository to host all dashboard developments ymh <ymh.work@gmail.com> parents: diff changeset	100
5f4fcbc80b37 Create new repository to host all dashboard developments ymh <ymh.work@gmail.com> parents: diff changeset	101	## Acknowledgments
5f4fcbc80b37 Create new repository to host all dashboard developments ymh <ymh.work@gmail.com> parents: diff changeset	102
7 5847345004db prepare project for first version ymh <ymh.work@gmail.com> parents: 0 diff changeset	103	* Thank you

author	ymh <ymh.work@gmail.com>
	Mon, 04 Apr 2022 17:02:10 +0200
changeset 26	eb14941af2e7
parent 11	37ecf0b9c174
permissions	-rw-r--r--