Skip to content

Latest commit

 

History

History
121 lines (99 loc) · 4.01 KB

SETUP.md

File metadata and controls

121 lines (99 loc) · 4.01 KB
Raw

Back to README

Getting Started

Content

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

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.

cloning forked repo

Already a Contributor

If you're already a contributor, then 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

Changing Branches

The dev branch has the most recent activity and updates to work with.

  # check current branch and branches
  $ git branch
  # change branches
  & git checkout dev
  # directly updates branch to the latest changes
  $ git pull origin dev

Updating a Branch

If you have forked the repo, then you'll have to update to the latest activity from the main repo. This requires setting up a remote origin with the main repo then fetching the updates.

Setting and Using an Upstream

  # add main repo as 'upstream'
  $ git remote add upstream https://github.com/inland-empire-software-development/main.git
  # fetch changes
  $ git fetch upstream
  # merge changes
  $ git merge upstream/master

You can use git pull instead of git fetch if you want to apply the changes directly, which is ideal if work just has begun. Additionally, you may also want to fetch changes from the main repo's branch as well, such as dev.

  # fetch changes from a branch
  $ git fetch upstream dev
  # merge changes to current branch
  $ git merge upstream/dev

Installation

This installs all the packages required to run the project.

NOTE: Yarn is required.

# install packages before running the app
$ yarn install

Mongo

You will need Mongo to run this application on your local machine. To install Mongo, go to this link and download the MongoDB Community Server. Choose the installation for your appropriate OS.

Local Development

NOTE: This make take a few minutes to start up. yarn dev will host a local server with the website, and will automatically rebuild and hotload changes.

# make sure you are in the `./main` project directory
$ yarn dev

Issues or Questions

Please visit us on Slack or leave an issue!