Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Doc] Add development instructions to DEVELOPMENT.md + folders to gitignore #262

Merged
merged 2 commits into from
Oct 10, 2023
Merged

[Doc] Add development instructions to DEVELOPMENT.md + folders to gitignore #262

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5f4091f
[Doc] Add instruction about DISABLE_AUTH to make it easier to test wi…
gmarciani Oct 10, 2023
4ea95fe
[Git] Add to gitignore: .ignore folder and files related to personal …
gmarciani Oct 10, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,6 @@ infrastructure/cognitolambda/node_modules
public/*
/frontend/tsconfig.tsbuildinfo
.idea/
.ignore
infrastructure/environments/*
!infrastructure/environments/demo-*
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why do we add the demo-* folder in gitignore?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The combo

infrastructure/environments/*
!infrastructure/environments/demo-*

means ignore everything in that folder but demo env files.

We added this because we want demo files to be tracked.

6 changes: 4 additions & 2 deletions DEVELOPMENT.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Install dependencies in your virtual environment:
pip install -r requirements.txt
```

When workin on the project, you may need to add a dependency.
When working on the project, you may need to add a dependency.
To do that you can the dependency with a specified version to the `requirements.in` file, and compile that file to produce the `requirements.txt`
After that, make sure to compile it using [pip-tools](https://github.com/jazzband/pip-tools).
To install pip-tools, just run
Expand All @@ -45,12 +45,14 @@ click on the App client and click *Edit* in the *Hosted UI* section, adding `htt
Then export the following variables:

```bash
export SECRET_ID=<the value of the UserPoolClientSecretName output from the Cognito stack>
export SECRET_ID=<the value of the UserPoolClientSecretName output from the PCUI stack>
export SITE_URL=http://localhost:5001
export AUDIENCE=<the value of the Client ID noted in the previous step>
export AUTH_PATH=<the UserPoolAuthDomain output of the ParallelClusterCognito nested stack>
```

Set `DISABLE_AUTH=False` in `api/utils.py` to facilitate live reloading.

Start the API backend by running:

```bash
Expand Down