Skip to content

Commit

Permalink
Updating CONTRIBUTING.md
Browse files Browse the repository at this point in the history
Filled in "How to Setup Your Development Environment" and updated table of contents.
  • Loading branch information
cryptictech authored Sep 12, 2018
1 parent 57ad21a commit 8429adf
Showing 1 changed file with 21 additions and 2 deletions.
23 changes: 21 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,11 @@

- [License](#license)
- [How to Setup Your Development Environment](#how-to-setup-your-development-environment)
- [Prerequisites](#prerequisites)
- [Fork Project](#fork-project)
- [Download Repository](#download-repository)
- [Install](#install-repository)
- [Start](#start-environment)
- [How to Contribute Code](#how-to-contribute-code)
- [Code Styling](#code-styling)
- [Other Ways of Contributing](#other-ways-of-contributing)
Expand All @@ -14,7 +19,21 @@ This software is written under the [GPL V3](LICENSE.md) license. This software i

## How to Setup Your Development Environment

TODO: Write this section
### Prerequisites
- NPM: Linux Command `sudo apt-get install npm`
- Node.js: Linux Command `sudo apt-get install nodejs`

### Fork Project
Fork the project into your repositories, this will allow you to commit your changes.

### Download Repository
You can either do this through a Github GUI like Github Desktop or GitKraken or you can do it through the terminal using `git clone https://github.com/YOUR-USERNAME/CIMS`

### Install Repository
Navigate to your new working directory in your terminal and type `npm install`. This will download any prerequisites and change any project settings needed to be able to run on your system.

### Start Environment
Navigate to your working directory in your terminal and type `npm start`. This will start the development server on your system, this server will automatically rerender any changes once you save a file.

## How to Contribute Code

Expand All @@ -26,4 +45,4 @@ TODO: Write this section

## Other Ways of Contributing

TODO: Write this section.
TODO: Write this section.

0 comments on commit 8429adf

Please sign in to comment.