Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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:

...

Note run portals on a port other than 3000 if you want to enable local user authentication (see section below).

How to use Login Authentication Locally with OneSage

In your terminalNext, run the snippet below to enable user authentication in your local environment:

...

Testing Synapse React Client (SRC) in Synapse Web Client (SWC)

...

Make your changes in SRC

...

Build UMD files for SRC using pnpm build:umd

...

Go to https://www.synapse.org in Chrome and open the Developer Tools

...

Refer to the README in the synapse-react-client

...

Go to the Sources tab in Developer Tools and go to the Overrides section. Make sure Enabled Local Overrides is checked.

  1. Screenshot 2024-12-05 at 12.14.24 PM-20241205-201427.pngImage Removed

...

right click cdn-www.synapse.org/generated or synapse-react-client.production.min.js and click open folder or containing folder respectively

...

In your file explore, navigate to packages/synapse-react-client/dist/umd/ and find the updated synapse-react-client.production.min.js file. Drag and drop this file to the generated folder to replace the old synapse-react-client.production.min.js file

...

Refresh https://www.synapse.org and the site should now be using your override file

...

directory of the Synapse Web Monorepo for instructions on how to do this.