Skip to content

Commit ddadf93

Browse files
authored
Update README.md
1 parent b955c2c commit ddadf93

File tree

1 file changed

+20
-18
lines changed

1 file changed

+20
-18
lines changed

README.md

Lines changed: 20 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,17 @@ This project was generated using [Angular CLI](https://github.com/angular/angula
1515
In general, you will need to have installed in your machine the following:
1616
- Git
1717
- Visual Studio code(most common) or your favourite editor
18+
- GPG
19+
- Git-crypt
20+
21+
###Git-crypt
22+
23+
You can install it by ruuning this command on linux `sudo apt-get install git-crypt`, for mac users `sudo port install git-crypt`.
24+
IMPORTANT: Windows users must install WSL to be able to install git-crypt.
25+
26+
### GPG
27+
28+
GPG is a encryption system used to create, import, export public and private keys; you can download it from here: https://gnupg.org/download/index.html. It can only work with a command shell but for Linux users, you can choose to work with <a href="https://apps.kde.org/kleopatra/" target="_blank">Kleopatra</a> if you feel confortable.
1829

1930
### Node.js
2031

@@ -49,26 +60,17 @@ In project path, open your favourite command line and run `npm install` in order
4960
# Prepare your environment
5061

5162
### Set environment variables
52-
**1**. Create a file keys.ts in the path `src/enviroment` with the content pinned in our slack channel #time-tracker-developer:
63+
**1**. Using GPG create your key by running this command in your favourite command shell: `gpg --generate-key`.
64+
65+
**2**. Export your public key into a file with this command: `gpg --export -a YOUR_REAL_NAME > public.key`.
66+
67+
**3**. Share your generated key file to your jr techlead.
68+
69+
**4**. Once your jr techlead added your key to the list, run this command: `git-crypt unlock` to decrypt your environment variables.
70+
5371

54-
```
55-
export const AUTHORITY = 'XXX';
56-
export const CLIENT_ID = 'XXX';
57-
export const SCOPES = ['XXX'];
58-
export const STACK_EXCHANGE_ID = 'XXX';
59-
export const STACK_EXCHANGE_ACCESS_TOKEN = 'XXX';
60-
export const AZURE_APP_CONFIGURATION_CONNECTION_STRING = 'XXX';
61-
```
62-
**2**. Create a second file `.keys.json` with the content pinned in the slack channel #time-tracker-developer:
63-
```
64-
{
65-
"authority": 'XXX',
66-
"client_id": 'XXX',
67-
"scopes": ["XXX"]
68-
}
69-
```
7072
### Prepare your environment for vscode
71-
Install the following extensions:
73+
Install the following extensions(optional):
7274

7375
- `Live Share`.
7476
- `GitLens`

0 commit comments

Comments
 (0)