Please direct questions about the technical underpinnings of this site to Brandon Budnicki.
Main file types
- Markdown - Docusaurus version
- .md which is plain markdown
- .js used for ReactJS components or special pages that require additional styling
- .json used to store raw data
The site follows the same standard Docusaurus structure.
/root /blog - news & articles specific to PPSR core /docs - .md and .mdx pages that contain the standard. These get versioned! /src /pages - special pages like the homepage /components - ReactJS components /static/json - JSON Schema files
This software can be run locally on your machine for testing purposes or creating larger changes. This will work on Windows, OSX, or Linux. The process is described in Docusaurus Installation except that you will be using an existing GitHub repository instead of "scaffolding" a new one.
These requirements are the same for all Docusaurus sites
GIT-SCM to clone, merge, and submit pull requests. To check for this software run this command from the terminal
NPM Version > 10.15.1 to build the software and run locally. To check for this software run this command from the terminal
A plaintext editor for exiting files. Do not use Microsoft Word Ses below for recommendation
We recommend the following additional tools to aid in content editing & ease of use. Install these if you are not experienced with software development, they will make your life easier.
- Visual Studio Code a plain text editor and development environment available for free on Windows, OSx, or Linux
- GitHub Desktop a friendly user interface for GIT-SCM
- GitLens a GitHub management extension for VS Code.
- Code Spell Checker extension for VS Code
Step by Step
After installing the Prerequisite Software:
Clone the repository from github.com/citizen-science-association/ppsr-core using the command line or GitHub Desktop
git clone https://github.com/citizen-science-association/ppsr-core.git
Install dependencies: Open a terminal / command line in the root folder of your repository
Run local build server: Open a terminal / command line in the root folder of your repository
npm run start
Your browser should automatically open to http://localhost:3000/
Any changes you save will immediately cause the page to refresh and be visible
Use this command to deploy to the live site.
GIT_USER=<GITHUB_USERNAME> npm run deploy
cmd /C "set GIT_USER=<GITHUB_USERNAME>&& npm run deploy"
Changes should appear within 2 minutes. Be sure to do a hard refresh of the page, locally cache files from the public site might show the old site.