16 |
17 |
17 ### Prerequisites for clientjs |
18 ### Prerequisites for clientjs |
18 |
19 |
19 - node and npm/npx |
20 - node and npm/npx |
20 |
21 |
21 |
|
22 ``` |
|
23 Give examples |
|
24 ``` |
|
25 |
|
26 ### Init env |
22 ### Init env |
27 |
23 |
28 #### ClientJS |
24 #### ClientJS |
29 |
25 |
30 - `cd clientjs` |
26 - `cd clientjs` |
31 - `npm install` |
27 - `npm install` |
32 - `npx lerna bootstrap` |
28 - `npx lerna bootstrap` |
33 - `cp packages/annotation-dashboard-explorunivers/.env packages/annotation-dashboard-explorunivers/.env.production` |
29 - `cp packages/annotation-dashboard-explorunivers/.env-tmpl packages/annotation-dashboard-explorunivers/.env.development` |
34 - Edit the file `packages/annotation-dashboard-explorunivers/.env.production` |
30 - Edit the file `packages/annotation-dashboard-explorunivers/.env.development` |
35 - `npx lerna run build` |
31 - `npx lerna run build` |
36 |
32 |
37 ### Installing |
33 ### Setup dev environment |
38 |
34 |
39 A step by step series of examples that tell you how to get a development env running |
35 #### setup Server |
40 |
36 |
41 Say what the step will be |
37 ##### isso |
|
38 Utilise pipenv : https://github.com/pypa/pipenv |
42 |
39 |
43 ``` |
40 - `cd server/isso/` |
44 Give the example |
41 - configure isso |
45 ``` |
42 - `cp isso.cfg.tmpl isso.cfg` |
|
43 - `pipenv install` |
|
44 - `pipenv run isso -c ./isso.cfg run` |
46 |
45 |
47 And repeat |
46 ##### Annotation proxy |
|
47 - `cd server/sbin/` |
|
48 - `cp hypothesis_proxy.conf.tmpl hypothesis_proxy.conf` |
|
49 - configure proxy |
|
50 - `pipenv install` |
|
51 - `pipenv run python ./hypothesis_proxy.py` |
48 |
52 |
49 ``` |
53 #### setup client js |
50 until finished |
|
51 ``` |
|
52 |
54 |
53 End with an example of getting some data out of the system or using it for a little demo |
55 - `cd clientjs` |
|
56 - `npm install` |
|
57 - `cp packages/annotation-dashboard-explorunivers/.env-tmpl packages/annotation-dashboard-explorunivers/.env.development` |
|
58 - configure .env.development file |
|
59 - `npx lerna bootstrap` |
54 |
60 |
55 ## Running the tests |
61 ##### build dashboard-components |
56 |
62 |
57 Explain how to run the automated tests for this system |
63 - `cd packages/dashboard-components` |
|
64 - `npm run start` |
58 |
65 |
59 ### Break down into end to end tests |
66 ##### build annotation-dashboard-explorunivers |
60 |
67 |
61 Explain what these tests test and why |
68 - `cd packages/annotation-dashboard-explorunivers` |
|
69 - `npm run start` |
62 |
70 |
63 ``` |
|
64 Give an example |
|
65 ``` |
|
66 |
|
67 ### And coding style tests |
|
68 |
|
69 Explain what these tests test and why |
|
70 |
|
71 ``` |
|
72 Give an example |
|
73 ``` |
|
74 |
71 |
75 ## Deployment |
72 ## Deployment |
76 |
73 |
77 Add additional notes about how to deploy this on a live system |
74 The Deployment use Ansble script. |
|
75 The process is described in the [deploy/README.md](deploy/README.md) file. |
78 |
76 |
79 ## Built With |
77 ## Built With |
80 |
78 |
81 * [Dropwizard](http://www.dropwizard.io/1.0.2/docs/) - The web framework used |
79 * [React.js](https://reactjs.org/) - The JS framework used |
82 * [Maven](https://maven.apache.org/) - Dependency Management |
80 * [Redux](https://redux.js.org/) - Datastore management |
83 * [ROME](https://rometools.github.io/rome/) - Used to generate RSS Feeds |
81 * [Bootstrap](https://getbootstrap.com/) - CSS Framework |
|
82 * [Isso](https://posativ.org/isso/) - Used for discussion threads |
|
83 * [Webpak](https://webpack.js.org/) - Js Bundler |
|
84 * [Lerna](https://lernajs.io/) - Lerna for packages managements |
|
85 * [Ansible](https://www.ansible.com/) - Ansible for deployment |
84 |
86 |
85 ## Contributing |
|
86 |
|
87 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. |
|
88 |
87 |
89 ## Versioning |
88 ## Versioning |
90 |
89 |
91 We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/your/project/tags). |
90 We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/your/project/tags). |
92 |
91 |
93 ## Authors |
|
94 |
|
95 * **Billie Thompson** - *Initial work* - [PurpleBooth](https://github.com/PurpleBooth) |
|
96 |
|
97 See also the list of [contributors](https://github.com/your/project/contributors) who participated in this project. |
|
98 |
92 |
99 ## License |
93 ## License |
100 |
94 |
101 This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details |
95 This project is licensed under the CeCILL-C - see the [LICENSE.md](LICENSE.md) file for details |
102 |
96 |
103 ## Acknowledgments |
97 ## Acknowledgments |
104 |
98 |
105 * Hat tip to anyone whose code was used |
99 * Thank you |
106 * Inspiration |
|
107 * etc |
|