Skip to content

Commit

Permalink
Removed yarn workspace functionality and documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
rennemannd committed Apr 15, 2020
1 parent 66c2416 commit 4faed93
Show file tree
Hide file tree
Showing 3 changed files with 434 additions and 186 deletions.
21 changes: 1 addition & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,32 +17,13 @@ The [backend](https://github.com/EngagingLearningLab/STEM-C/tree/master/server#s
## Environments

### Development
This project's dependencies are managed through [yarn](https://classic.yarnpkg.com/en/docs/install/#mac-stable) (this must be installed) using [yarn workspaces](https://classic.yarnpkg.com/en/docs/workspaces/). This allows both client and server folder dependencies to only depend on one package-lock file, reducing possible dependency version issues. From the project root running the command `yarn` will install dependencies for both the client and server.
This project's dependencies are managed through [yarn](https://classic.yarnpkg.com/en/docs/install/#mac-stable)
The following are the available scripts we can use with the client and server:
#### `yarn workspace server dev`
Runs both the client app and the server app in development mode.<br>
Open [http://localhost:3000](http://localhost:3000) to view the client in the browser.<br><br>

#### `yarn workspace client start`
Runs just the client app in development mode.<br>
Open [http://localhost:3000](http://localhost:3000) to view the client in the browser.<br><br>


#### `yarn workspace server start`
Runs just the server in development mode.<br><br>


#### `yarn workspace server build`
Builds the app for production to the `build` folder.<br>
It correctly bundles React in production mode and optimizes the build for the best performance.<br><br>


### Deployment

Coming soon...



## Contributing

### Git Flow
Expand Down
Loading

0 comments on commit 4faed93

Please sign in to comment.