Skip to content

Commit bc5cab0

Browse files
author
Igor Ramadas
committed
Updated core and dependencies.
1 parent 3daedf0 commit bc5cab0

File tree

3 files changed

+62
-159
lines changed

3 files changed

+62
-159
lines changed

README.md

Lines changed: 6 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Strautomator is using the [SetMeUp](https://github.com/igoramadas/setmeup) modul
1212
- **settings.secret.json** - private credentials and secrets, excluded from the GIT repo
1313
- **settings.local.json** - private local-only settings, excluded from the GIT repo
1414

15-
Please note that the [Core](https://github.com/strautomator/core) also has its own collection of settings files as well.
15+
Please note that the [Core](https://github.com/strautomator/core) also has its own collection of settings files as well. If the same setting is define on the Core and on the Web, the Web settings has the higher priority.
1616

1717
## Local setup
1818

@@ -26,24 +26,17 @@ First, create a folder on your machine that will server as the root all the Stra
2626
$ cd ~/strautomator
2727
$ git clone [email protected]:strautomator/web.git
2828
$ git clone [email protected]:strautomator/core.git
29+
$ cd core
30+
$ make update
31+
$ cd ../
2932
$ cd web
3033
$ make update
3134

3235
### Local settings
3336

34-
Make a copy of the [settings.secret.json.sample](https://github.com/strautomator/web/blob/master/settings.secret.json.sample) and name it `settings.secret.json`. This is where you'll store all the credentials and sensitive keys. This file is encrypted automatically whenever the application starts up.
35-
36-
For other non-sensitive data, you can create a `settings.local.json`. This file is kept in clear text.
37-
38-
You can also just use one or the other file for development, depending on how concerned you are with security vs. convenience.
39-
40-
The following settings are mandatory:
41-
42-
- **gcp.projectId**: the ID of your project on GCP (Google Cloud Platform)
43-
- **maps.api.key**: a client-restricted GCP API key to be used with Google Maps
44-
- **strava.api**: clientId and clientSecret from Strava
37+
Make a copy of the [settings.secret.json.sample](https://github.com/strautomator/web/blob/master/settings.secret.json.sample) and name it `settings.secret.json`. This is where you'll store all the credentials and sensitive keys. This file is encrypted automatically whenever the application starts up. You can also encrypt and decrypt on demand by using the `$ make encrypt` and `$ make decrypt` commands.
4538

46-
All other credentials are optional. You can set them as needed, depending on which features you'll want to use.
39+
For other non-sensitive data, you can create a `settings.local.json`. This file is kept in clear text on your local machine.
4740

4841
### Setting the URL
4942

0 commit comments

Comments
 (0)