Our Imagine Cup 2020 project is built on top of NestJS. A progressive Node.js framework for building efficient and scalable server-side applications.

Frontend instructions

Install the release_version_install_me_on_android.apk file on your android device (placed in the root folder as README.md)

Or

Install react native, yarn and launch an android emulator

$ cd frontend/react-native-app
$ yarn install
$ react-native run-android

Installation

Install all the necessary packages using npm:

$ npm install

To Configure Redis and PostGres SQL Database, use .env-example to copy & paste the variables into your own .env file.

Running the API

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

Test

# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov

Project Inception

Our project went through initial inception and partial Proof of Concept development at the Oxford Hack 2019, hosted by the University of Oxford and Major League Hacking. The project won 2 awards and the DevPost can be found here.

Technologies

PostGres SQL
Redis
NestJS [Backend API Architecture]
ExpressJS [Backend Framework]
React [Web App Frontend]
React Native [Mobile App Frontend]
Microsoft Azure Maps Route Matrix
Firebase Cloud Messaging

License

Our project for Microsoft's Imagine Cup 2020 is MIT licensed.