Forking this repository

How to

This article is only pertinent for repository's that will be created and maintained by the Software Services team at Scientist.com.

---

As of August 9, 2023, we are choosing to base client repo’s on a fork of this repo, instead of turning this repo into a template. If you are interested in the discussion about that decision, it can be found here.

Follow the steps below to fork the webstore to the scientist-softserv organization, instead of your personal account.

• Visit https://github.com/scientist-softserv/webstore
• Press the “+” button in the top right corner and select “new repository” from the drop down menu
• Update the required “owner” and “repository name” fields
  • owner: scientist-softserv
  • repository name: <client>-digital-storefront
• Change the visibility to public and press “create repository”
• Navigate to your local version of the webstore (or clone it locally if you haven’t already)
• Once there:
  • git remote add <client> https://github.com/scientist-softserv/<client>-digital-storefront.git
  • git push <client>
• Refresh the page at github.com/scientist-softserv/<client>-digital-storefront
• Success! 🎉

Now you can clone the newly forked repo you created and begin working!

Staying synced

If changes are made to this repository that you'd like to bring into the fork, use the steps below

• Add a new remote that points to this repository: git remote add <name> https://github.com/scientist-softserv/webstore.git
  • e.g. git remote add upstream https://github.com/scientist-softserv/webstore.git
• The main branch in the forked repo will be different than the one in this repo. You will need to set your config to merge (opposed to rebase or fast-forward) when handling reconciliation.
  • git config pull.rebase false
• Pull in the main branch: git pull upstream main
• Fix any merge conflicts and push to the remote

Common updates after forking

There may be additional changes needed depending on the requirements of the new repository, but begin at the places below:

• name in "package.json"
• Environment variables
• "cypress.config.js"
• "docker-compose.yaml"
• All sentry config files
• Deployment configuration