Onboarding
- Kiana McCullough
This document is intended to streamline the onboarding process by providing key resources and instructions for navigating the Synapse web ecosystem. Feel free to comment and share your feedback on this document to help improve it and make this resource even more helpful!
Getting Started with the Synapse Web Monorepo
The Synapse Web Monorepo is a centralized codebase for projects related to synapse.org. For an overview of the Synapse web ecosystem, visit the Web Engineering - Links document.
Installation
Refer to the README in the Synapse Web Monorepo for installation instructions.
Running a portal locally
Refer to the README in the portals directory of the Synapse Web Monorepo for instructions on how to do this.
How to use Login Authentication Locally with OneSage
In your terminal, run the snippet below to start a portal (I’m using the ELITE portal as an example but you can replace elportal below with the name of the portal you wish to run:
pnpm nx run elportal:start --host --port 3001Note run portals on a port other than 3000 if you want to enable local user authentication.
Next, run the snippet below to enable user authentication in your local environment:
pnpm nx run SageAccountWeb:start --host --port 3000Note this has to be on port 3000 to work!
Synapse Web Client (SWC)
The Synapse Web Client is a single-page application that serves as the frontend for accessing Synapse REST services. Visit synapse.org to see the latest SWC release build.
Setting Up a Local Web Client
Refer to this document.
Testing Synapse React Client (SRC) in Synapse Web Client (SWC)
Refer to the README in the synapse-react-client directory of the Synapse Web Monorepo for instructions on how to do this.
We could also consider linking to the SWC bootstrap doc (https://sagebionetworks.jira.com/wiki/spaces/SWC/pages/15597754)!
Also a link to the Web Engineering Links doc, which should give a new engineer an overview of the code repo landscape: https://sagebionetworks.jira.com/wiki/spaces/PS/pages/2638086170
This is a great section, but I think there are many other concepts during onboarding that are described somewhere, but this could be the document that brings together those scattered resources.
Getting Started with the Synapse mono-repo.
Running a portal locally.
A note about running the OneSage Synapse Account website locally for login. And probably other things (Anthony/Loren and others to offer what they wish they were told up front!)