1 # Annotation Dashboard

     2 

     3 This repository contains rthe code for IRI annotations dashboards.

     4 

     5 ## Getting Started

     6 

     7 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.

     8 

     9 ### Prerequisites

    10 

    11 ### Prerequisites for server

    12 

    13 - Python 3.7

    14 - pipenv

    15 - envrc

    16 

    17 ### Prerequisites for clientjs

    18 

    19 - node and npm/npx

    20 

    21 

    22 ```

    23 Give examples

    24 ```

    25 

    26 ### Init env

    27 

    28 #### ClientJS

    29 

    30 - `cd clientjs`

    31 - `npm install`

    32 - `npx lerna bootstrap`

    33 - `cp packages/annotation-dashboard-explorunivers/.env packages/annotation-dashboard-explorunivers/.env.production`

    34 - Edit the file `packages/annotation-dashboard-explorunivers/.env.production`

    35 - `npx lerna run build`

    36 

    37 ### Installing

    38 

    39 A step by step series of examples that tell you how to get a development env running

    40 

    41 Say what the step will be

    42 

    43 ```

    44 Give the example

    45 ```

    46 

    47 And repeat

    48 

    49 ```

    50 until finished

    51 ```

    52 

    53 End with an example of getting some data out of the system or using it for a little demo

    54 

    55 ## Running the tests

    56 

    57 Explain how to run the automated tests for this system

    58 

    59 ### Break down into end to end tests

    60 

    61 Explain what these tests test and why

    62 

    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 

    75 ## Deployment

    76 

    77 Add additional notes about how to deploy this on a live system

    78 

    79 ## Built With

    80 

    81 * [Dropwizard](http://www.dropwizard.io/1.0.2/docs/) - The web framework used

    82 * [Maven](https://maven.apache.org/) - Dependency Management

    83 * [ROME](https://rometools.github.io/rome/) - Used to generate RSS Feeds

    84 

    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 

    89 ## Versioning

    90 

    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). 

    92 

    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 

    99 ## License

   100 

   101 This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details

   102 

   103 ## Acknowledgments

   104 

   105 * Hat tip to anyone whose code was used

   106 * Inspiration

   107 * etc