Provide a devcontainer setup for Fauxton #1488
Open
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Overview
This PR provides a devontainer setup for developing Fauxton. There are
** NO CHANGES TO FAUXTON CODE**
Devcontainer use is strictly optional, so nothing changes when a developer doesn't use it. They provide a consistent configuration with standardized dependency versions.
The devcontainer starts Fauxton development and an auxiliary CouchDB side container.
Optional an IdP container for JWT functionality can be added.
Sample configuration scripts are provided (see readme.md)
populate_couchdb.sh
: create databases_users
,_relicator
,_global_changes
anddemo
populate_keycloak.sh
: configure the keycloak server with the realmempire
, a clientfauxton
and the usershariseldon
,gaaldormick
. Furthermore extract the public key from the JWKS, convert it to PEM and configure JWT authentication in CouchDB including trusting that keyTesting recommendations
Open the project in a supported IdE (e.g. VS-Code) and get prompted to reopen the project in devcontainer.
First time configuration might take a while but finally starts
npm run dev
GitHub issue number
Fixes #1486
Related Pull Requests
n/a
Checklist