@@ -6,11 +6,11 @@ nav_order: 4
6
6
# Epidata API Development Guide
7
7
8
8
** Prerequisite:** this guide assumes that you have read the
9
- [ frontend development guide] ( https://github.com/cmu-delphi/operations/blob/master /docs/frontend_development.md ) .
9
+ [ frontend development guide] ( https://github.com/cmu-delphi/operations/blob/main /docs/frontend_development.md ) .
10
10
11
11
This guide describes how to write and test code for the Epidata API. For
12
12
preliminary steps,
13
- [ install docker and create a virtual network] ( https://github.com/cmu-delphi/operations/blob/master /docs/frontend_development.md#setup ) .
13
+ [ install docker and create a virtual network] ( https://github.com/cmu-delphi/operations/blob/main /docs/frontend_development.md#setup ) .
14
14
15
15
After reading this guide, you may want to visit
16
16
[ the ` fluview_meta ` tutorial] ( new_endpoint_tutorial.md ) for an example of how
@@ -28,7 +28,7 @@ You likely won't need to modify the `operations` repo, so cloning directly from
28
28
` cmu-delphi ` is usually sufficient. However, since you _ are_ going to be
29
29
modifying ` delphi-epidata ` sources, you'll first need to fork the repository
30
30
and then clone your personal fork. For more details, see the Delphi-specific
31
- [ discussion on forking and branching] ( https://github.com/cmu-delphi/operations/blob/master /docs/backend_development.md#everyone ) .
31
+ [ discussion on forking and branching] ( https://github.com/cmu-delphi/operations/blob/main /docs/backend_development.md#everyone ) .
32
32
33
33
Here's an example of how to setup your local workspace. Note that you will need
34
34
to use your own GitHub username where indicated.
@@ -124,9 +124,9 @@ docker run --rm -p 127.0.0.1:10080:80 \
124
124
Unit tests are self-contained, and do not depend on external services like
125
125
databases or web servers. You can run unit tests at any time according to the
126
126
instructions in the
127
- [ backend development guide] ( https://github.com/cmu-delphi/operations/blob/master /docs/backend_development.md ) .
127
+ [ backend development guide] ( https://github.com/cmu-delphi/operations/blob/main /docs/backend_development.md ) .
128
128
129
- First, [ build the ` delphi_python ` image] ( https://github.com/cmu-delphi/operations/blob/master /docs/backend_development.md#creating-an-image ) .
129
+ First, [ build the ` delphi_python ` image] ( https://github.com/cmu-delphi/operations/blob/main /docs/backend_development.md#creating-an-image ) .
130
130
Your test sources will live in, and be executed from within, this image.
131
131
132
132
Then run the tests in a container based on that image:
@@ -242,7 +242,7 @@ point for additional tests. For example, see the tests for the
242
242
243
243
To run the existing tests and any new tests that you write, you must
244
244
follow the
245
- [ backend development guide] ( https://github.com/cmu-delphi/operations/blob/master /docs/backend_development.md )
245
+ [ backend development guide] ( https://github.com/cmu-delphi/operations/blob/main /docs/backend_development.md )
246
246
_ within the same workspace_ , so that the ` delphi_python ` image is created with
247
247
any changes you have made (e.g. adding new integration tests). That image will
248
248
contain the test driver and the source code of your integration tests. Then,
@@ -259,7 +259,7 @@ More concretely, you can run Epidata API integration tests like this:
259
259
above.
260
260
261
261
3 . Build the ` delphi_python ` image per the
262
- [ backend development guide] ( https://github.com/cmu-delphi/operations/blob/master /docs/backend_development.md#creating-an-image ) .
262
+ [ backend development guide] ( https://github.com/cmu-delphi/operations/blob/main /docs/backend_development.md#creating-an-image ) .
263
263
Your test sources will live in, and be executed from within, this image.
264
264
265
265
4 . Run integration tests in a container based on the ` delphi_python ` image:
@@ -297,7 +297,7 @@ This allows your code changes to be reflected immediately, without needing to
297
297
rebuild containers.
298
298
299
299
There are some drawbacks however, as discussed in the
300
- [ Epicast development guide] ( https://github.com/cmu-delphi/www-epicast/blob/master /docs/epicast_development.md#develop ) .
300
+ [ Epicast development guide] ( https://github.com/cmu-delphi/www-epicast/blob/main /docs/epicast_development.md#develop ) .
301
301
For example:
302
302
303
303
- Code running in the container is able to read (and possibly also write) your local filesystem.
0 commit comments