Venue is a platform that allows instructors to give students credit for attending events. An instructor signs on and creates courses and events, students can then use the venue app to upload event submissions, which can contain images or GPS data that verifies a student attended an event.
This project was generated with the Angular Full-Stack Generator version 3.1.0.
Getting Started
Deploying with Docker
If you'd like the run venue without modifying it, you can use our docker image which you can find at rcos/venue on the docker hub.
The instructions for running the docker image are available on docker hub.
Prerequisites
- Git
- Node.js and npm Node = 8.10.x, npm >= 2.x.x
- Gulp (
npm install --global gulp
) - MongoDB - Keep a running daemon with
mongod
Developing
-
Run
npm install
to install server dependencies. -
Run
mongod
in a separate shell to keep an instance of the MongoDB Daemon running -
Run
gulp serve
to start the development server. It should automatically open the client in your browser when ready.
Note: if downgrading/updating to Node 8.10.x, it's recommended to clear wrong versions of modules by running rm -rf node_modules
before npm install
.
Build & development
Run gulp build
for building and gulp serve
for preview.
Building the Docker Image
To build the docker image, go to your venue directory and run the following command.
docker build -t rcos/venue .
You can then upload your image (assuming you have the correct permissions) using
docker push rcos/venue
Testing
Running npm test
will run the unit tests with karma.