Skip to content

How to Contribute

Jump to bottom
Max Kohler edited this page Jul 26, 2023 · 2 revisions

Setting up your development environment

You only need to do these steps once. If you've never worked in a version-controlled environment you might want to read Version Control at PRIF before you continue.

Required Software

You need the following tools to work on this repository:

Forward this list to IT and have them install everything on it on your machine before you continue. All of this software is open-source and requires no licensing.

Accessing this repo

  1. Sign up for a free Github account using your work email and let an admin know what your username is, so they can add you to our organisation. You must enable two-factor authentication to join our organisation.
  2. Once you’ve accepted your invitation, run git clone https://github.com/Peace-Research-Institute-Frankfurt/websites.git to make a local copy of this repository
  3. Open the command line, navigate to the newly-created folder and run npm install to download and install all necessary dependencies (this might take a few minutes).

Making changes

  1. Open your project's subfolder (like /new-work) in Visual Studio Code
  2. Run npm run start in the built-in command line to start a live preview at localhost:8000.
  3. Make your changes
  4. Use the command line or the version control panel in Visual Studio Code to commit and push your changes to the repository. Your changes should be automatically deployed in about 60 seconds. The deployment status section at the top of this page shows your project's deployment status in real time.
Clone this wiki locally