From 16979e07d3bb22e4fc9fb1212ad0bd768db4664e Mon Sep 17 00:00:00 2001 From: Justin Campbell Date: Thu, 9 Jul 2020 16:06:43 -0400 Subject: [PATCH] Update Dev Environment Setup Guide --- Dev Environment Setup Guide.md | 26 ++++++++++++++++++++++++++ Dev Logs.md | 1 + README.md | 6 ++++-- 3 files changed, 31 insertions(+), 2 deletions(-) diff --git a/Dev Environment Setup Guide.md b/Dev Environment Setup Guide.md index f520592..1bbb698 100644 --- a/Dev Environment Setup Guide.md +++ b/Dev Environment Setup Guide.md @@ -8,3 +8,29 @@ ## Setup **Note:** webqueue2 uses npm and create-react-app to manage itself. You can learn more about npm [here](https://nodesource.com/blog/an-absolute-beginners-guide-to-using-npm/) and create-react-app [here](https://create-react-app.dev/docs/getting-started/). + +### Step 1: Create a Project Directory +```bash +mkdir project-dir && cd project-dir +``` + +### Step 2: Close the Reposistory +```bash +git clone https://github.rcac.purdue.edu/ECN/webqueue2.git +``` + +### Step 3: Install npm Packages +```bash +npm install +``` + +### Step 4: Start Developing +There are three built in npm scripts that come from create-react-app: + +1. `npm run start`: This will start a local development server on [localhost:3000](http://localhost:3000) and launch your default browser at that address. As you save changes in /public and/or /src you'll see your changes in the browser. + +1. `npm run build`: This will build a static version of the site in /build ready to be placed in the document root of any web server. + +1. `npm run test`: This will run any tests (using the [Jest](https://jestjs.io/) tester). There are currently no defined tests. + +1. `npm run eject`: **THIS IS NON-REVERSABLE**: This will abstract all of the build environment settings and make them available to you. See the [create-reacte-app docs on ejecting](https://create-react-app.dev/docs/available-scripts#npm-run-eject) for more information. \ No newline at end of file diff --git a/Dev Logs.md b/Dev Logs.md index 00f15ab..43b5a12 100644 --- a/Dev Logs.md +++ b/Dev Logs.md @@ -59,6 +59,7 @@ These are daily and weekly summaries of the work thats been done on webqueue2. T - Continued work on responsive table - More than two weeks have been spent trying to make the material-table library work, another library shuld be considered for what is needed here. [react-table](https://github.com/tannerlinsley/react-table) looks functionally promising thought thematically challenging. - Moved from feature-configure-reactjs back to master +- Finished [Dev Environment Setup Guide](https://github.rcac.purdue.edu/ECN/webqueue2/blob/master/Dev%20Environment%20Setup%20Guide.md) diff --git a/README.md b/README.md index 38bd1b8..71b736f 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ # webqueue2 A re-write of Purdue ECN's webqueue -See the test at [https://engineering.purdue.edu/qwebtest/](https://engineering.purdue.edu/qwebtest/) +See the current beta at [https://engineering.purdue.edu/qwebtest/](https://engineering.purdue.edu/qwebtest/) -Read the [Dev Logs](https://github.rcac.purdue.edu/ECN/webqueue2/blob/feature-configure-reactjs/Dev%20Logs.md) +Get involed by reading the [Dev Environment Setup Guide](https://github.rcac.purdue.edu/ECN/webqueue2/blob/master/Dev%20Environment%20Setup%20Guide.md) + +Read the [Dev Logs](https://github.rcac.purdue.edu/ECN/webqueue2/blob/master/Dev%20Logs.md)