Skip to content

Commit 9cd567b

Browse files
committed
2022/dockerize: Update Readme File (add docker section)
1 parent 2214735 commit 9cd567b

File tree

2 files changed

+44
-8
lines changed

2 files changed

+44
-8
lines changed
File renamed without changes.

README.md

Lines changed: 44 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,30 @@
11
If you are coming from a specific video, you can have a look at the commits, they are named like: 'video-01: asd', 'video-02: asd', so you can switch to a commit/merge commit and see what exactly had been done, since this repo is currently evolving and sometimes parts of it are rewritten in newer videos.
2+
Hint: Upon 2022 the new features are not prefixed like this anymore (cause there isn't a video for every step anymore).
23

3-
# instructions to run the project
4-
## 1. Switch to branch develop to get the latest changes
5-
## 2. Add an environment file to the project
4+
# Updated 2022 (Project now dockerized)
5+
This Project is now dockerized.
6+
We have one Dockerfile for the api (NestJS) and one for the frontend(Angular).
7+
On the top file level there is a `docker-compose.yml` file that you can start, there is also the database and everything configured. So you don't need to do anything else than run `docker-compose up`.
8+
9+
# Instructions to run the Project
10+
11+
## With Docker
12+
Command:
13+
`docker-compose up`
14+
and then visit `localhost:4200`
15+
16+
### Tipps & Tricks for docker
17+
If you need to remove docker images or containers you can use one of the following commands.
18+
19+
Command to remove all images:
20+
`docker rmi -f $(docker images -a -q)`
21+
22+
Command to remove all containers:
23+
`docker rm -vf $(docker ps -a -q)`
24+
25+
26+
## Without Docker
27+
### 2. Add an environment file to the project
628
Add a .env file in the api folder (at the top of your api folder, so nest can find it)
729
- add your own DATABASE_URL in the .env file
830
- add your own JWT_SECRET in the .env file
@@ -21,17 +43,17 @@ Example of file:
2143
JWT_SECRET=jklasjdoij897231na
2244

2345

24-
## Start the Backend in dev Mode after you added the .env file
46+
### Start the Backend in dev Mode after you added the .env file
2547
`cd api`
2648
`npm install`
2749
`npm run start:dev`
2850

29-
## Start the Frontend in dev Mode after you added the .env file
51+
### Start the Frontend in dev Mode after you added the .env file
3052
`cd frontend`
3153
`npm install`
3254
`ng serve`
3355

34-
## Start the e2e tests
56+
# Start the e2e tests
3557
`cd e2e`
3658
`npm install`
3759
`npm run cypress:open`
@@ -43,9 +65,23 @@ Example of file:
4365
Blog Project only NestJS Videos
4466
https://www.youtube.com/playlist?list=PLVfq1luIZbSnytbsm2i8Ocf_hyUHTsqbZ
4567

46-
4768
Blog Project only Angular Videos
4869
https://www.youtube.com/playlist?list=PLVfq1luIZbSmAWiXmsjUsvdYRu7RdxzaM
4970

5071
Blog Project All Videos
51-
https://www.youtube.com/playlist?list=PLVfq1luIZbSmJIuw_EZVP9mFiMED5fGIn
72+
https://www.youtube.com/playlist?list=PLVfq1luIZbSmJIuw_EZVP9mFiMED5fGIn
73+
74+
Playlist 2022:
75+
<tbd>
76+
77+
# Other Links & Stuff
78+
Link to Github Profile: https://github.com/ThomasOliver545
79+
Link to Youtube Channel: https://www.youtube.com/channel/UCTZMwW4pq_B-o_KkpCtotGw
80+
Link to Twitter: https://twitter.com/Thomas_OliverK
81+
82+
Since i am doing this in my freetime support via
83+
- "Github Sponsor"
84+
- "Github Follow"
85+
- "Youtube Follow"
86+
87+
etc. would be great.

0 commit comments

Comments
 (0)