Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
12 changes: 12 additions & 0 deletions backend/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Change Log

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](http://keepachangelog.com/)
and this project adheres to [Semantic Versioning](http://semver.org/).


## [0.0.1] - 2021-11-10

### Added
- Allow for missing first/last names in userinfo, defaulting to " "
Copy link
Member

Choose a reason for hiding this comment

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

are we doing the changelog now?

4 changes: 2 additions & 2 deletions backend/app/routers/keycloak.py
Original file line number Diff line number Diff line change
Expand Up @@ -123,8 +123,8 @@ async def auth(
# create user in db if it doesn't already exist; get the user_id
userinfo = keycloak_openid.userinfo(access_token)
keycloak_id = userinfo["sub"]
given_name = userinfo["given_name"]
family_name = userinfo["family_name"]
given_name = userinfo.get("given_name", " ")
family_name = userinfo.get("family_name", " ")
email = userinfo["email"]
user = UserDB(
email=email,
Expand Down
6 changes: 3 additions & 3 deletions backend/docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@ Uses [Sphinx](https://www.sphinx-doc.org). Requires [enchant](https://pyenchant.

```shell
# build
make build
make html

# view
python -m http.server --directory build/html
python3 -m http.server --directory build/html

# check links
make linkcheck
Expand All @@ -22,4 +22,4 @@ make spelling
```

Great [talk](https://www.youtube.com/watch?v=0ROZRNZkPS8) on Sphinx.
Sphinx [themes](https://sphinx-themes.org/).
Sphinx [themes](https://sphinx-themes.org/).
Binary file added backend/docs/source/img/pycharm1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added backend/docs/source/img/pycharm1a.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added backend/docs/source/img/pycharm2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions backend/docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ Welcome to Clowder v2's documentation!
:caption: Contents:

mongo-fastapi.md
pycharm.md



Expand Down
21 changes: 21 additions & 0 deletions backend/docs/source/pycharm.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
### How to setup pycharm to work with Clowder V2

From the main menu select Run -> Edit Configurations...

Click on '+' to add a 'Python' configuration, and name it 'uvicorn'

![Run/Debug_Config1](img/pycharm1.png)

Select 'Module name" and use: 'uvicorn'

With parameters: 'app.main:app --reload'

![Run/Debug_Config_line1](img/pycharm1a.png)

Click '+' again and add a 'JavaScript Debug' configuraion, and name it 'frontend'

![Run/Debug_Config2](img/pycharm2.png)

With URL: 'http://localhost:3000'

and I chose 'Chrome' browser