Skip to content

Commit 4b68dc6

Browse files
authored
Update README.md
1 parent a04b5f5 commit 4b68dc6

File tree

1 file changed

+32
-7
lines changed

1 file changed

+32
-7
lines changed

README.md

Lines changed: 32 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,24 +12,49 @@ This project was generated using [Angular CLI](https://github.com/angular/angula
1212

1313
## Prerequisites
1414

15+
In general, you will need to have installed in your machine the following:
16+
- Git
17+
- Visual Studio code(most common) or your favourite editor
18+
1519
### Node.js
1620

17-
Install Node.js from [https://nodejs.org/en/download/] but we recommend that you install it using Node Version Management [https://github.com/nvm-sh/nvm] (v12.16.1 LTS).
21+
We strongly recommend that you install it using Node Version Management [https://github.com/nvm-sh/nvm] (v12.16.1 LTS) due to some project will only work with a specific version and by using Node Version Management you can switch between versions.
1822

1923
### Angular CLI
2024

2125
Angular CLI is a Command Line Interface (CLI) to speed up your development with Angular.
2226

2327
Run `npm install -g @angular/cli` to install Angular CLI
2428

29+
### Docker
30+
31+
You can download it from here: https://www.docker.com/get-started/ you will find the perfect Docker version for you.
32+
33+
### Chocolatey
34+
35+
By installing this, you'll be able to use the commands to run your proyect.
36+
You can do it by following the steps here https://chocolatey.org/install. Although the page tells you to use Powershell, you should be able to use any command line with admin permissions. Don't forget to select the "Individual button" before following the installation steps.
37+
38+
![image](https://user-images.githubusercontent.com/42116904/166069074-f76d9bd3-01b9-4c50-92e7-c7558d026783.png)
39+
40+
### Make
41+
42+
You will need to install Make for you to be easier setting your environment.
43+
In your command line with admin permissions run `choco install make`
44+
2545
## Install Node Modules
2646

27-
Run `npm install` to install the required node_modules for this project.
47+
In project path, open your favourite command line and run `npm install` in order to be able to run the project locally.
2848

2949
## Development server
3050

31-
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.
32-
The app will automatically reload if you change anything in the source files.
51+
Yo have 2 ways to run this project in dev mode:
52+
**First**:
53+
- In your project path, open your favourite command line and run the follwing commands: `make build` then `make run` and finally `make log`. When the project is successfully compiled you can go to `http://localhost:4200/` in your browser. Remember you must have your Docker running.
54+
**Second**:
55+
- 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. This method is usefull when you want to run a specific branch using less time but not recommended when doing QA.
56+
57+
In any case, the app will automatically reload if you change anything in the source files.
3358

3459
# Prepare your environment
3560

@@ -55,8 +80,8 @@ export const AZURE_APP_CONFIGURATION_CONNECTION_STRING = 'XXX';
5580
### Prepare your environment for vscode
5681
Install the following extensions:
5782

58-
- `EditorConfig for Visual Studio Code`.
59-
- `TSLint`
83+
- `Live Share`.
84+
- `GitLens`
6085
- `Prettier - Code formatter`.
6186
- Go to user settings (`settings.json`) and enable formatting on save: `"editor.formatOnSave": true`.
6287

@@ -143,4 +168,4 @@ Shared file with all the Feature Toggles we create, so we can have a history of
143168
[Feature Toggles dictionary](https://github.com/ioet/time-tracker-ui/wiki/Feature-Toggles-dictionary)
144169

145170
## More information about the project
146-
[Starting in Time Tracker](https://github.com/ioet/time-tracker-ui/wiki/Time-tracker)
171+
[Starting in Time Tracker](https://github.com/ioet/time-tracker-ui/wiki/Time-tracker)

0 commit comments

Comments
 (0)