Here at Protegé, we use create-react-app on the front-end, Tailwind CSS for styling, and Google Firebase for the back-end. Getting a local environment set up is fairly simple. If something isn't clear, create an issue and let us know how we can improve this document.
Develop
branch as your base for changesyarn
to install peer dependenciesAdd app
and the web app icon </>
. Register app
. .env.local.template
file included in this repository..env.local.template
to .env.local
yarn emulators
- launches the firebase emulator
yarn dev
- builds the sitedbseed.js
in the root directory of this repo from another terminal session. You can do this by running node dbseed.js
. This will populate the data with some test data.
Before we get too far, we'd like to say thank you for considering contributing to Protegé.dev!
We use Atlassian's Git Workflow model for version control on Protegé.
What that means is that we have a Main branch, a Develop branch, and then feature/feature-name or hotfix/hotfix-name branches for development of the platform.
To keep in line with this workflow, your process for submitting a PR should follow the steps below.
Fork the repo to your local dev environment
Create a new branch under the feature/
flag
Name the branch in a concise way that eludes to what it does (ex: feature/add-active-nav-state
)
Create your PR into the Develop branch
Leave a short message in the PR explaining in slightly more detail what the PR accomplishes.
If your PR touches multiple parts, consider adding a bullet list of accomplishments, example below
* adds new component x for data handling
* updates component y to use component x
* refactors component y for code reusability