Skip to content
This repository was archived by the owner on Jan 23, 2022. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
80 changes: 78 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,78 @@
# degree-planner
CSESoc Projects - Degree Planner
# CSESoc Projects - Degree Planner

## Getting Started

### Prerequisites

You will need npm and yarn installed on your machine. Tested on Linux - Ubuntu 18.10

### Running whole Web Application

The below will clone the repo, install the dependencies and run both the front end and back end concurrently.
```
git clone https://github.com/csesoc/degree-planner.git
cd degree-planner
yarn install
cd client
yarn install
cd ../server
yarn install
cd ..
yarn dev
```

You can then visit ```http://localhost:3000/``` for the front end and ```http://localhost:3001/``` for the back end

### Running client only

```
git clone https://github.com/csesoc/degree-planner.git
cd degree-planner/client
yarn install
yarn start
```

You can then visit ```http://localhost:3000/``` for the front end

### Running server only

```
git clone https://github.com/csesoc/degree-planner.git
cd degree-planner/server
yarn install
yarn start
```

You can then visit ```http://localhost:3001/``` for the back end

## Built With

* [React](https://reactjs.org/)
* [create-react-app](https://facebook.github.io/create-react-app/)
* [Express.js](https://expressjs.com)
* [Node.js](https://nodejs.org/en/)

## Contributing

Please contact the CSESoc Projects Portfolio Director(s) to find out how to contribute to the project.

## Authors

* **Jonathan Charles** - *Team Lead* - [jcharles8246](https://github.com/jcharles8246)
* **Kevin Zhang** - *Backend Developer* - [ChaoQlate](https://github.com/ChaoQlate)
* **Jacq** - *Frontend Developer* - [jacq-jacq](https://github.com/jacq-jacq)
* **Lilian Wang** - *Frontend Developer* - [xLilianW](https://github.com/xLilianW)
* **Melanie So** - *Fullstack Developer* - [melanieso](https://github.com/melanieso)
* **Jeremy Lim** - *Fullstack Developer* - [HitoKage13](https://github.com/HitoKage13)
* **Clarence Feng** - *Backend Developer* - []()

See also the list of [contributors](https://github.com/your/project/contributors) who participated in this project.

## Acknowledgments

Thanks to the following projects for providing inspiration and assistance in creation of this project.

* [Bojangles](http://tdransfield.net/utilities/bojangles)
* [Crossangles](https://my.campusbiblestudy.org)
* [Pathways](https://github.com/csesoc/pathways)
* [UPlanner](https://uplanner.bopa.ng)
5 changes: 3 additions & 2 deletions client/package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
{
"name": "client",
"version": "0.1.0",
"name": "degree-planner-client",
"version": "0.0.1",
"private": true,
"proxy": "http://localhost:3001",
"dependencies": {
"react": "^16.8.6",
"react-dom": "^16.8.6",
Expand Down
4 changes: 2 additions & 2 deletions client/yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -7846,7 +7846,7 @@ react-dev-utils@^9.0.1:
strip-ansi "5.2.0"
text-table "0.2.0"

react-dom@16.8.6:
react-dom@^16.8.6:
version "16.8.6"
resolved "https://registry.yarnpkg.com/react-dom/-/react-dom-16.8.6.tgz#71d6303f631e8b0097f56165ef608f051ff6e10f"
integrity sha512-1nL7PIq9LTL3fthPqwkvr2zY7phIPjYrT0jp4HjyEQrEROnw4dG41VVwi/wfoCneoleqrNX7iAD+pXebJZwrwA==
Expand Down Expand Up @@ -7926,7 +7926,7 @@ react-scripts@3.0.1:
optionalDependencies:
fsevents "2.0.6"

react@16.8.6:
react@^16.8.6:
version "16.8.6"
resolved "https://registry.yarnpkg.com/react/-/react-16.8.6.tgz#ad6c3a9614fd3a4e9ef51117f54d888da01f2bbe"
integrity sha512-pC0uMkhLaHm11ZSJULfOBqV4tIZkx87ZLvbbQYunNixAAvjnC+snJCg0XQXn9VIsttVsbZP/H/ewzgsd5fxKXw==
Expand Down
13 changes: 13 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
{
"name": "degree-planner",
"version": "0.0.1",
"private": true,
"scripts": {
"client": "cd client && yarn start",
"server": "cd server && yarn start",
"dev": "concurrently --kill-others-on-fail \"yarn server\" \"yarn client\""
},
"dependencies": {
"concurrently": "^4.1.0"
}
}
2 changes: 1 addition & 1 deletion server/bin/www
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ var http = require('http');
* Get port from environment and store in Express.
*/

var port = normalizePort(process.env.PORT || '3000');
var port = normalizePort(process.env.PORT || '3001');
app.set('port', port);

/**
Expand Down
4 changes: 2 additions & 2 deletions server/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "server",
"version": "0.0.0",
"name": "degree-planner-server",
"version": "0.0.1",
"private": true,
"scripts": {
"start": "node ./bin/www"
Expand Down
Loading