Skip to content

Commit efd2f0d

Browse files
BB2-4079: Update developer docs (#1384)
* BB2-4079: Update developer docs to current state * Update django version in link * One more django version update, fix typo
1 parent 2191394 commit efd2f0d

File tree

2 files changed

+16
-12
lines changed

2 files changed

+16
-12
lines changed

CONTRIBUTING.md

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,11 @@ These instructions provide a quick start for developers new to the project. You'
3333
sudo apt-get install python3-dev libxml2-dev libxslt1-dev
3434
```
3535

36+
**Mac Homebrew example:**
37+
```bash
38+
brew install python libxml2 libxslt
39+
```
40+
3641
**For other operating systems:** Install equivalent development packages for your platform.
3742

3843
### Building the Project
@@ -52,18 +57,17 @@ source venv/bin/activate # On Windows: venv\Scripts\activate
5257
pip install --upgrade pip
5358
pip install pip-tools
5459
pip install -r requirements/requirements.txt
55-
56-
# Set up Django settings
57-
cp hhs_oauth_server/settings/local_sample.txt hhs_oauth_server/settings/local.py
5860
```
5961

6062
**Configure your environment:**
61-
Edit `hhs_oauth_server/settings/local.py` with your local settings. Most settings can be overridden by environment variables. Please ensure to create and use your own keys and secrets.
63+
Copy the environment variables from .env.example to .env, editing what you need to for your local settings.
64+
Other environment variables used in the codebase are available in the docker-compose directory, in the different.env files. Please ensure to create and use your own keys and secrets.
6265

6366
**Initialize the database:**
6467
```bash
6568
python manage.py migrate
66-
python manage.py loaddata apps/accounts/fixtures/scopes_and_groups.json
69+
python manage.py loaddata apps/accounts/fixtures/scopes.json
70+
python manage.py loaddata apps/accounts/fixtures/groups.json
6771
python manage.py createsuperuser
6872
python manage.py create_admin_groups
6973
python manage.py create_blue_button_scopes
@@ -113,12 +117,12 @@ gulp watch
113117
We follow standard GitHub Flow practices:
114118

115119
1. **Fork the project** (external contributors) or create a branch (internal contributors)
116-
2. **Check out the `main` branch**
120+
2. **Check out the `master` branch**
117121
3. **Create a feature branch** with a descriptive name
118122
4. **Write code and tests** for your change
119-
5. **From your branch, make a pull request** against `CMSGov/bluebutton-web-server/main`
123+
5. **From your branch, make a pull request** against `CMSGov/bluebutton-web-server/master`
120124
6. **Work with repo maintainers** to get your change reviewed
121-
7. **Wait for your change to be merged** into `main`
125+
7. **Wait for your change to be merged** into `master`
122126
8. **Delete your feature branch** after successful merge
123127

124128
### Testing Conventions
@@ -186,7 +190,7 @@ See our `.github/ISSUE_TEMPLATE.md` for more examples.
186190
### Writing Pull Requests
187191

188192
**Pull Request Guidelines:**
189-
- File pull requests against the `main` branch
193+
- File pull requests against the `master` branch
190194
- Include a clear description of changes
191195
- Reference any related issues
192196
- Ensure all tests pass

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Chronic Conditions Warehouse (https://www.ccwdata.org)
1616

1717
For more information on how to connect to the API implemented here, check out our developer documentation at https://cmsgov.github.io/bluebutton-developer-help/. Our most recent deployment is at https://sandbox.bluebutton.cms.gov, and you can also check out our Google Group at https://groups.google.com/forum/#!forum/developer-group-for-cms-blue-button-api for more details.
1818

19-
The information below outlines setting up the server for development or your own environment. For general information on deploying Django see https://docs.djangoproject.com/en/1.11/howto/deployment/.
19+
The information below outlines setting up the server for development or your own environment. For general information on deploying Django see https://docs.djangoproject.com/en/4.2/howto/deployment/.
2020

2121
NOTE: Internal software engineers or other interested parties should follow the documentation for running a Dockerized local development enviornment. For more information see https://github.com/CMSgov/bluebutton-web-server/blob/master/docker-compose/readme.md.
2222

@@ -72,7 +72,7 @@ pip install pip-tools
7272
pip install -r requirements/requirements.txt
7373
```
7474

75-
Note that most settings can be overridden by environment variables. See custom environment variables section below. Please ensure to create and use your own keys and secrets. See https://docs.djangoproject.com/en/1.11/topics/settings/ for more information. Continue the installation by issuing the following commands:
75+
Note that most settings can be overridden by environment variables. See custom environment variables section below. Please ensure to create and use your own keys and secrets. See https://docs.djangoproject.com/en/4.2/topics/settings/ for more information. Continue the installation by issuing the following commands:
7676

7777
```bash
7878
python manage.py migrate
@@ -84,7 +84,7 @@ python manage.py create_blue_button_scopes
8484
python manage.py create_test_user_and_application
8585
```
8686

87-
The next step is optional: If your backend HAPI FHIR server is configured to require x509 certificates to access it then you need to obtain that keypair and place those files in certificate folder called `cerstore`.
87+
The next step is optional: If your backend HAPI FHIR server is configured to require x509 certificates to access it then you need to obtain that keypair and place those files in certificate folder called `certstore`.
8888

8989
```bash
9090
mkdir ../certstore

0 commit comments

Comments
 (0)