You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<ahref="https://gitduck.com/codebuddies/join?t=60ktFkh1Rqnd_AS1kR8ZGyH"target="_blank">Join CodeBuddies on GitDuck</a>
18
+
8
19
## Features
9
20
10
21
-**Auto-reload** - modify the application code in your editor of choice. As you save changes, the application should reload automatically. There should be no need to restart containers to see code changes.
@@ -62,13 +73,13 @@ You can access the database through the Adminer front-end or using a local Postg
62
73
63
74
64
75
65
-
5. Create a superuser so that you can log into `http://localhost:8000/admin` by running the following in your terminal:
76
+
5. Create a superuser so that you can log into `http://localhost:8000/admin` by running the following in your terminal:
66
77
67
78
```bash
68
79
$ docker-compose run --rm app ./manage.py createsuperuser
69
80
```
70
81
71
-
6. You can populate the database with some random test data for development purposes by running
82
+
6. You can populate the database with some random test data for development purposes by running
72
83
73
84
```bash
74
85
$ docker-compose run --rm app ./manage.py init_data
@@ -105,7 +116,6 @@ optional arguments:
105
116
106
117
[See PR 127]
107
118
108
-
109
119
---
110
120
111
121
To stop the application and remove all containers, run the following:
@@ -162,9 +172,9 @@ docker-compose run --rm app ./manage.py help
162
172
<br>
163
173
Postman is a free interactive tool for verifying the APIs of your project. You can download it at postman.com/downloads.
164
174
165
-
Postman is an interactive tool for verifying the APIs of your project in an isolated environment--think of it as a a virtual playground where we can safely experiment and edit our API before we deploy it on our web app--just like virtual environments help us isolate our python dependencies.
175
+
Postman is an interactive tool for verifying the APIs of your project in an isolated environment--think of it as a a virtual playground where we can safely experiment and edit our API before we deploy it on our web app--just like virtual environments help us isolate our python dependencies.
166
176
167
-
We've created a shared Postman collection (a .json file) in the postman folder to help contributors more easily reproduce observed behaviour in our dev API.
177
+
We've created a shared Postman collection (a .json file) in the postman folder to help contributors more easily reproduce observed behaviour in our dev API.
168
178
169
179
To get it set up, please follow these steps:
170
180
@@ -173,23 +183,24 @@ To get it set up, please follow these steps:
173
183
Downloading Postman
174
184
Please make sure it is at least v7.6.0, if installed, or you are downloading the latest stable version.
175
185
Linux,
186
+
176
187
- Distro package manager:
177
188
- use the search feature to find in your package manager
178
189
- (RECOMMENDED) Flatpak
179
190
- After setting up flatpak it through flatpak using flatpak install postman and enter "yes"/"y" for all the questions it will ask. Flatpak is designed to provide the most up-to-date versions of software for most distros, so if you have the option, use Flatpak to guarantee Linux OS compatibility and to keep Postman up-to-date.
180
191
181
192
2. Once you have Postman open, click on file -> import and import the .json file
182
-
3. Click on the settings gear icon on the far top right (next to the eye icon) and click to add a new environment.
193
+
3. Click on the settings gear icon on the far top right (next to the eye icon) and click to add a new environment.
183
194
4. Name your environment `dev` and create a variable called `api_url`. Give it a value of `https://localhost:8000`, which is the URL of your Django dev environment when it is running.
184
195
5. Now, as long you have the Django app (https://localhost:8000) running, you should be able to make requests like POST Create User and POST Authenticate.
185
-
Click on this link to see what you should expect: https://imgur.com/hd9VB6k
196
+
Click on this link to see what you should expect: https://imgur.com/hd9VB6k
186
197
187
-
-`POST` Create User will create a new user in your `localhost:8000` running Django app,
198
+
-`POST` Create User will create a new user in your `localhost:8000` running Django app,
188
199
- making a request to `POST Authenticate` will authenticate whether or not that user exists.
189
200
190
-
201
+
191
202
192
-
5. Now, as long you have the Django app (https://localhost:8000) running, you should be able to make requests like `POST Create User` and `POST Authenticate` by clicking on the blue "Send" button in Postman.
203
+
5. Now, as long you have the Django app (https://localhost:8000) running, you should be able to make requests like `POST Create User` and `POST Authenticate` by clicking on the blue "Send" button in Postman.
193
204
194
205
</details>
195
206
@@ -255,13 +266,12 @@ Please see [How to contribute here]
0 commit comments