Skip to content

Commit a3eb34a

Browse files
committed
Update readme
1 parent 040abaf commit a3eb34a

File tree

1 file changed

+13
-3
lines changed

1 file changed

+13
-3
lines changed

README.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Simple boilerplate for django & django rest framework
88
### Tasks list
99
- [x] Users api CRUD endpoints
1010
- [x] DRF JWT Authentication
11-
- [ ] Add docker configurations
11+
- [x] Add docker configurations
1212
- [ ] Document folder structure
1313
- [ ] Configure Static/media & templates
1414
- [ ] Integrate material ui & react js on templates
@@ -29,8 +29,18 @@ PUT | `/api/user/update/{pk}` | Edit a user
2929
DELETE | `/api/user/destroy/{pk}` | Delete a user
3030

3131

32-
### Installation
33-
If you wish to run your own build, first ensure you have python globally installed in your computer. If not, you can get python (here)[python.org].
32+
### Installation
33+
If you wish to run your own build, you two options
34+
1. User Docker compose.
35+
36+
`$ git clone https://github.com/p8ul/django-rest-framework-boilerplate`
37+
38+
`$ cd django-rest-framework-boilerplate`
39+
`$ docker-compose up`
40+
41+
2. Without docker
42+
43+
First ensure you have python globally installed in your computer. If not, you can get python [here](python.org).
3444

3545
After doing this, confirm that you have installed virtualenv globally as well. If not, run this:
3646

0 commit comments

Comments
 (0)