https://github.com/optimalstrategy/comp231
https://github.com/optimalstrategy/comp231
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/optimalstrategy/comp231
- Owner: optimalstrategy
- Created: 2021-03-09T12:44:41.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2021-04-18T04:16:25.000Z (about 5 years ago)
- Last Synced: 2025-01-22T18:11:34.635Z (over 1 year ago)
- Language: Jupyter Notebook
- Size: 14.2 MB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Software Development Project
## Setup
0. Install [MongoDB](https://docs.mongodb.com/manual/tutorial/install-mongodb-on-windows/) and [RabbitMQ](https://www.rabbitmq.com/install-windows.html).
Make sure that both programs are configured and running.
1. Clone the repo:
```bash
$ git clone https://github.com/optimalstrategy/COMP231
```
and switch to `dev`
```bash
$ git checkout dev
```
2. Install the dependencies
```bash
$ npm install -g typescript ts-node nodemon
$ npm install
```
3. Run the tests. You should see something like this:
```bash
$ npm test
> jest
PASS server/routes/demoRoute.test.ts
A sample test demonstrating how to test APIs
✓ Request / should return HTTP 200 OK (54 ms)
Test Suites: 1 passed, 1 total
Tests: 1 passed, 1 total
Snapshots: 0 total
Time: 1.875 s, estimated 2 s
```
4. Run the backend server
```bash
$ nodemon
```
## Development server
Run `nodemon` for a dev server. The serve will be listening on `http://localhost:3000/`. The app will automatically reload if you change any of the source files.