https://github.com/tatumalenko/coursebin

SOEN 341 Team Project Repo
https://github.com/tatumalenko/coursebin

Last synced: 7 days ago
JSON representation

SOEN 341 Team Project Repo

• Host: GitHub
• URL: https://github.com/tatumalenko/coursebin
• Owner: tatumalenko
• License: gpl-3.0
• Created: 2019-01-11T17:25:02.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2023-01-03T23:46:26.000Z (about 2 years ago)
• Last Synced: 2023-04-23T19:17:42.093Z (over 1 year ago)
• Language: JavaScript
• Size: 3.2 MB
• Stars: 1
• Watchers: 3
• Forks: 1
• Open Issues: 39
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# CourseBin

The SOEN341 course project repository.

## Getting Started

**NOTE 1:** *We use* `yarn` *in this project instead of* `npm` *because it handles sub-folder module dependencies better (the* `client` *folder contains it's own* `node_modules`*).*

**NOTE 2:** *Make sure to read* `CONTRIBUTING.md` *before starting to develop on this project or Tatum will spank you.*

Clone the repo:

```

git clone https://github.com/tatumalenko/CourseBin.git

```

Change directory into repo:

```

cd CourseBin

```

Switch to the appropriate branch:

```

git checkout basic-project-prototype-2

```

If you need to create a new issue branch, instead use these commands **(remember, each branch must follow from an issue created on GitHub)**:

```

git brach 

git checkout 

```

Install the required root node modules:

```

yarn install

```

Change directory into the client folder:

```

cd client

```

Install the required client node modules:

```

yarn install

```

Change back into the root directory:

```

cd ..

```

Create a new file `.env` in the root directory and add the necessary stuff (See Basecamp Docs & Files):

```

touch .env

vim .env

...

```

Start both frontend and backend servers:

```

yarn dev

```

To instead run the production build, execute the following command which first builds the frontend files and starts only a backend server:

```

yarn start

```

Enjoy!