Skip to content

Commit

Permalink
Update Dev Environment Setup Guide
Browse files Browse the repository at this point in the history
  • Loading branch information
Justin Campbell committed Jul 9, 2020
1 parent 56e1383 commit 16979e0
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 2 deletions.
26 changes: 26 additions & 0 deletions Dev Environment Setup Guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`: <span style="background-color: #fff394">**THIS IS NON-REVERSABLE**</span>: 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.
1 change: 1 addition & 0 deletions Dev Logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

<!-- ### Friday - 7/10/20 -->
<!-- ### Saturday - 7/11/20 -->
Expand Down
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -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)

0 comments on commit 16979e0

Please sign in to comment.