Skip to content

Latest commit

 

History

History
50 lines (31 loc) · 2.41 KB

README.md

File metadata and controls

50 lines (31 loc) · 2.41 KB
Raw

UW Research Computing Website

Netlify Status

This website is built using Docusaurus 2, a modern static website generator. SVG logos provided using VectorLogoZone or logosear.ch. Using the offline search plugin from @lelouch77.

JS Frameworks Installation

Set up your local environment by installing all the required JS frameworks by using yarn.

$ yarn install

Local Development

NOTE: Need to run export NODE_OPTIONS=--openssl-legacy-provider before starting up dev environment.

This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.

$ yarn start

If all JS frameworks are staged (from previous step) then yarn start should spin up a local dev instance at http://localhost:3000

Build

This will generate the static website into the build folder. It's not necessary as pull requests to the main repository will kick off CI processes to deploy the website.

$ yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

This last stage is for manual deployment to the master branch. It is not required if Travis-CI is set up appropriately as pull requests will automatically perform this command and build the src branch into static content and deploy on the master branch.

$ GIT_USER=UWrc yarn deploy

Code Contribution

  1. Create a local branch using git checkout -b feature/feature_name. Try to be specific with naming and use either bugfix or feature to help guide the team in what they are looking at.
  2. Make your commits then push the branch to the central repository on Github (e.g., git push origin mybranch).
  3. Use the Github website to manually create a pull request (PR) and document in more detail your changes. Tag a specific team member to review, if appropriate.
  4. Once all necessary reviewing parties (minimum 1) review your code, perform a final review and either merge your code interactively through Github or using the Git CLI if you feel an interactive rebase is necessary for cleanup.