https://github.com/Sage-Bionetworks/portals
React component based configurations that generate community portals built on top of Synapse
https://github.com/Sage-Bionetworks/portals
Last synced: 21 days ago
JSON representation
React component based configurations that generate community portals built on top of Synapse
- Host: GitHub
- URL: https://github.com/Sage-Bionetworks/portals
- Owner: Sage-Bionetworks
- License: apache-2.0
- Archived: true
- Created: 2019-04-29T20:42:03.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-07-17T19:08:27.000Z (almost 2 years ago)
- Last Synced: 2024-04-11T01:25:57.157Z (about 1 year ago)
- Language: TypeScript
- Homepage:
- Size: 15.5 MB
- Stars: 4
- Watchers: 12
- Forks: 18
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-synapse - portals - React component based configurations that generate community portals built on top of Synapse (Portals)
README
### This repo has been archived since it has been moved into the [synapse-web-monorepo](https://github.com/Sage-Bionetworks/synapse-web-monorepo)
----
# A single codebase for Synapse portals
### Example sites:
- [AMP-AD Knowledge Portal](https://adknowledgeportal.synapse.org)
- [NF Data Portal](https://nf.synapse.org)
- [CSBC / PS-ON Data Portal](https://csbc-pson.synapse.org)
### Building a portal
- src/configurations is the folder of all existing portals
- src/configuration/config-shell is a portal template that can be copied and filled out where the TODOs are written.
### Running a portal locally
To run a portal locally, use the linkConfig script, which copies configuration files for the portal that you specify
(replace \ with one of the subfolder names, like `nf` or `adknowledgeportal`):
```
./linkConfig.sh
```
To run a portal with a local version of SRC run the following commands:
```sh
# In Synapse-React-Client/
# Symlink the package itself as well as the local react, react-router, and react-router-dom packages
$ yarn link-src
$ yarn build # last step is to build the project
# In portals/
$ yarn link-src
$ ./linkConfig
# Note that you can make changes in the SRC project and reflect
# them in the portals by running yarn build again. The portals project
# can continue to run as you make changes.
```
To unlink synapse react-client run `yarn unlink-src`
# Build/Deploy Process
Note - [Jenkins](http://build-system-portals.sagebase.org:8080/login) is accessible only through VPN, reach out to IT to set this up.
## Automatic Updates to Staging
When a pull request is merged, the following will occur:
If `package.json` was updated all the staging websites will be built automatically.
If any file under `src/configurations/portal-name/*` is updated then the staging site for **portal-name** will update.
e.g. updating `src/configurations/adknoweldgeportal/routesConfig.ts` will update adknowledgeportal staging.
## Jenkins Jobs
Job Naming:
Each portal has its own staging job, named `deploy-portalname-staging`, e.g. `deploy-cancercomplexity-staging`
Making a new staging job
- Copy one of the staging jobs
- Change the `Source Code Management/Additional Behaviours/Included Regions` section to only include that portal's configuration folder.
- Change the `Build/Execute Shell` section to build the portal
## Deploy the Staging version to Production
Run `deploy-portal-production` with parameters, using the portal's folder name, e.g. 'nf' or 'cancercomplexity'
This will copy everything from the staging bucket to the production bucket for that portal. Approval from the portal owner must be obtained before running this job.
## Jenkins build script
The code that is run on jenkins is in `run.sh`
Usage:
Sync current with staging:
`$ ./run.sh push-staging [portal-name]`
Sync production with production:
`$ ./run.sh WARNING-push-production [portal-name]`