SETUP.md

Back to README

Getting Started

Content

• Not yet a contributor
• Already a contributor
• Prerequisite
• Cloning
• Installation
• Running the project

Not yet a contributor

If you're not a contributor you can contact an admin on Slack to become a contributor or you can fork the repo and contribute from there.

• How to fork

• Afterwards, clone the repo from your fork by copying the url provided
  • NOTE: Unless you understand SSH, make sure you clone using HTTPS. It should say Clone with HTTPS
  • Check Installation guidelines if you're unsure how to clone.

Already a contributor

If you're already a contributor, then just follow the instructions below.

Prerequisite

These are the basic requirements to get the project running on your machine

• git (to clone the repository and push changes to the repo)
• yarn (to install packages)

Cloning

Getting a copy of the project onto your machine.

  # clone the repo using https
  $ git clone https://github.com/inland-empire-software-development/landing.git

  #for people who fork, it should look like this
  $ git clone https://github.com/your_github_username/landing.git

Installation

This installs all the packages required to run the project.

NOTE: Yarn is required.

# install packages before running the app
$ yarn install

Running the project on your computer

NOTE: This make take a few minutes to start up.

# starting the project
# make sure you are in the project directory
$ yarn start