Skip to content

development-guide.md

Latest commit

 

History

History
49 lines (35 loc) · 1.8 KB

development-guide.md

File metadata and controls

49 lines (35 loc) · 1.8 KB
description Johan Cervantes - December 17, 2021

Development guide

Setting up the environment

For reference, this is the current repository https://github.com/CovEducation/coveducation.github.io

I assume that NPM & NodeJS are installed in the system. If not, here's a guide.

~ > git clone git@github.com:CovEducation/coveducation.github.io.git
~ > cd coveducation.github.io
# Install dependencies
~/coveducation.github.io > npm install 
~/coveducation.github.io > npm run build

If all the commands above worked, the environment has been setup correctly.

Running the site

~/coveducation.github.io > npm run serve

Development

This command should hot-reload any changes made to the site:

~/coveducation.github.io > npm run develop

Other commands can be found in the projects' package.json file.

Deploying changes

  1. Create a new branch with your changes
  2. Create a pull-request and get it reviewed by someone.
    1. Feel free to assign them to me, I will do my best to review them in a reasonable time frame.
    2. If it's urgent, DM me on Messenger
  3. After the PR is merged, a GitHub action picks up the changes, rebuilds then site, and deploys it.
  4. DO NOT FORGET THIS STEP:
    1. For some reason, after the website is redeployed via Github pages, the redirect between coved.org -> coveducation.github.io is broken. You
    2. Double check the project's setting page (You need admin access for this!). It should look like this: