From 8429adf3c756ea059660d5f4ee914305b0d9cd51 Mon Sep 17 00:00:00 2001 From: pbcub1 Date: Tue, 11 Sep 2018 18:56:01 -0600 Subject: [PATCH] Updating CONTRIBUTING.md Filled in "How to Setup Your Development Environment" and updated table of contents. --- CONTRIBUTING.md | 23 +++++++++++++++++++++-- 1 file changed, 21 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7fec6b1..43c619c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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) @@ -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 @@ -26,4 +45,4 @@ TODO: Write this section ## Other Ways of Contributing -TODO: Write this section. \ No newline at end of file +TODO: Write this section.