Skip to content

Tt 196 update readme #656

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed

Tt 196 update readme #656

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
13438e1
feat: TT-188 add & remove groups to user service
thegreatyamori Mar 24, 2021
9ae5a61
docs: TT-196 update readme
scastillo-jp Apr 1, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
docs: TT-196 update readme
  • Loading branch information
@scastillo-jp
scastillo-jp committed Apr 1, 2021
commit 9ae5a616e6cecf8721ec692b8bb2bf7d7d1916f6
24 changes: 20 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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';
Expand All @@ -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:

Expand Down Expand Up @@ -82,6 +89,12 @@ Install the following extensions:
| `feat(pencil): add 'graphiteWidth' option` | ~~Minor~~ Feature Release |
| `perf(pencil): remove graphiteWidth option`<br><br>`BREAKING CHANGE: The graphiteWidth option has been removed.`<br>`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`.

Expand Down Expand Up @@ -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)
[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)