diff --git a/README.md b/README.md index f35dd32dc..99859696f 100644 --- a/README.md +++ b/README.md @@ -31,10 +31,10 @@ Run `npm install` to install the required node_modules for this project. Run `ng serve` to run the app in dev mode. After executing this command, you can navigate to `http://localhost:4200/` to see the app working. The app will automatically reload if you change anything in the source files. -## Prepare your environment +# Prepare your environment ### Set environment variables -Create a file keys.ts in the path `src/enviroment` with the content pinned in our slack channel: +**1**. Create a file keys.ts in the path `src/enviroment` with the content pinned in our slack channel #time-tracker-developer: ``` export const AUTHORITY = 'XXX'; @@ -44,7 +44,14 @@ export const STACK_EXCHANGE_ID = 'XXX'; export const STACK_EXCHANGE_ACCESS_TOKEN = 'XXX'; export const AZURE_APP_CONFIGURATION_CONNECTION_STRING = 'XXX'; ``` - +**2**. Create a second file `.keys.json` with the content pinned in the slack channel #time-tracker-developer: +``` +{ + "authority": 'XXX', + "client_id": 'XXX', + "scopes": ["XXX"] +} +``` ### Prepare your environment for vscode Install the following extensions: @@ -82,6 +89,12 @@ Install the following extensions: | `feat(pencil): add 'graphiteWidth' option` | ~~Minor~~ Feature Release | | `perf(pencil): remove graphiteWidth option`

`BREAKING CHANGE: The graphiteWidth option has been removed.`
`The default graphite width of 10mm is always used for performance reasons.` | ~~Major~~ Breaking Release | +### Branch names format +For example if your task in Jira is **TT-48 implement semantic versioning** your branch name is: +``` + TT-48-implement-semantic-versioning +``` + ## Code scaffolding Run `ng generate component component-name` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module`. @@ -127,4 +140,7 @@ To get more help on the Angular CLI use `ng help` or go check out the [Angular C ## Feature Toggles dictionary Shared file with all the Feature Toggles we create, so we can have a history of them -[Feature Toggles dictionary](https://github.com/ioet/time-tracker-ui/wiki/Feature-Toggles-dictionary) \ No newline at end of file +[Feature Toggles dictionary](https://github.com/ioet/time-tracker-ui/wiki/Feature-Toggles-dictionary) + +## More information about the project +[Starting in Time Tracker](https://github.com/ioet/time-tracker-ui/wiki/Time-tracker) \ No newline at end of file