From 5866e4ee6efe6e99e56d11f3581071d5d458cbc3 Mon Sep 17 00:00:00 2001 From: NJaku01 Date: Tue, 22 Dec 2020 14:56:23 +0100 Subject: [PATCH] token_template + readme --- .gitignore | 2 +- README.md | 37 +++++++++++++++++++++++++++++++++++++ private/tokens_template.js | 6 ++++++ 3 files changed, 44 insertions(+), 1 deletion(-) create mode 100644 private/tokens_template.js diff --git a/.gitignore b/.gitignore index 4a256c6..2d54186 100644 --- a/.gitignore +++ b/.gitignore @@ -24,7 +24,7 @@ hs_err_pid* .idea/ node_modules/ -private/ +tokens.js package-lock.json api/config.yml \ No newline at end of file diff --git a/README.md b/README.md index 0c8d1fa..a47063d 100644 --- a/README.md +++ b/README.md @@ -2,3 +2,40 @@ #### Accident data source https://unfallatlas.statistikportal.de/ + +## Getting Started + + +To get a local copy up and running follow these simple steps. + +### Prerequisites + +Install npm +* npm +```sh +npm install npm@latest -g +``` + +### Installation + +1. Clone the repo +```sh +git clone https://github.com/NJaku01/NJaku01.github.io.git +``` +2. Install NPM packages +```sh +npm install +``` + +3. Get your openrouteservice token at https://openrouteservice.org/dev/#/signup + +4. Rename the tokens_template.js file inside the private folder to tokens.js + +5. Add your key, received in step 3, at the routing spot in the tokens.js file + +6. Start the application +```sh +npm start +``` + +7. Go to the application under https://localhost:3000 diff --git a/private/tokens_template.js b/private/tokens_template.js new file mode 100644 index 0000000..f202e35 --- /dev/null +++ b/private/tokens_template.js @@ -0,0 +1,6 @@ +if (typeof exports == "undefined"){ + var exports = window; + }; + exports.token = { + routing: "your-token", // get it here: https://openrouteservice.org/dev/#/signup + }; \ No newline at end of file