A CDH Studio Room Booking Application
Explore the docs »
Demo
·
Website/ Screenshots
·
View Wiki
Jarvis is a simplified room booking application that provides a solution to the issues currently present at ISED, namely a complicated and time consuming room booking process. Jarvis works on top of the current Outlook system and is designed to save employees time, money, and increase productivity. Main features include:
- The ability to view and book available rooms
- Detailed information about rooms including images, available equipment, and more!
- Manage bookings
- A review system
- Reporting system
- Outlook integration
Jarvis provides an integrated administrator dashboard, where admins will have the ability to access and utilize room and user statistics to allow ISED to make smarter investment decisions. In addition, Jarvis allows administrators to add additional rooms, edit existing room details and statuses, manage users, bookings, and existing issues.
Developed by the Winter 2019 students at CDH Studio, this application is currently in it’s beta. Any questions, suggestions, and bugs should be directed to Yunwei Li or Ali Nouri at (cdhstudio.jarvis@gmail.com)
- Ali Nouri - Technical Lead/Mentor
- Majd Khodr - Full-stack Developer
- Peter Lam - Full-stack Developer
- Yunwei Li - Full-stack Developer
To get a local copy up and running follow these simple example steps.
The commands provided beyond this point are linux based. The preferred local environment is a ubuntu 18.04 LTS virtual machine.
Follow the steps below to install the virtual machine:
-
Download and install Virtual Box from the following link. Last tested version: 6.0
-
Download the VM image (VirtualBox Appliance) and load into Virtual box
** link to ubuntu image configured with proxy by Ali here **
NOTE: Please read the README file included in the zip to find the password for image
-
Boot up the VM and test you have network connection. If you are having issue it is often related to proxy settings
-
If you are having problems with screen resolution and clipboard sharing between Guest and Host OS then please install the Ubuntu Guest additions:
-
$ sudo apt update
$ sudo apt upgrade
$ sudo apt install build-essential dkms linux-headers-$(uname -r) -
Next, from the Virtual Machine menu bar, go to Devices => click on Insert Guest Additions CD image as shown in the screenshot. This helps to mount the Guest Additions ISO file inside your virtual machine.
-
Next, you will get a dialog window, prompting you to Run the installer to launch it.
-
A terminal window will be opened from which the actual installation of VirtualBox Guest Additions will be performed. Once the installation is complete, press [Enter] to close the installer terminal window. Then power off your Ubuntu guest OS to change some settings from VirtualBox manager as explained in the next step.
-
inside the VM you can now install your dev tools. we rommend:
- Git
- Visual studio Code
PLEASE NOTE: The proxy setting of Git might have to be configured manually if it int picked up automatically form the system settings.
We use docker within the VM to further standardize the dev environment. You can run docker in windows if you get correct permissions from IT support but for consistency of environment we recommend using the VM provided above.
Install Docker
$ sudo apt-get update
$ sudo apt-get install docker-ce docker-ce-cli containerd.io
Install Docker Compose
Run this command to download the current stable release of Docker Compose:
$ sudo curl -L "https://github.com/docker/compose/releases/download/1.25.0/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
Apply executable permissions to the binary:
$ sudo chmod +x /usr/local/bin/docker-compose
Configure Docker Proxy Settings
Create a systemd drop-in directory:
$sudo mkdir /etc/systemd/system/docker.service.d
open config file
sudo gedit /etc/systemd/system/docker.service.d/
copy the following code into the file:
[Service]
Environment="HTTP_PROXY=https://http://cdhwg01.prod.prv:80/"
Environment="HTTPS_PROXY=https://http://cdhwg01.prod.prv:80/"
Environment="NO_PROXY=localhost,127.0.0.1,localaddress,0.0.0.0"
flush changes
$ sudo systemctl daemon-reload
Verify that the configuration has been loaded:
$ sudo systemctl show --property Environment docker
Output should be: "Environment=HTTP_PROXY=http://cdhwg01.prod.prv:80/"
Restart Docker
$ sudo systemctl restart docker
To run the application for local environment cd in to your project directory inside the virtual machine and run.
docker-compose up
The application is now served at the following address
http://0.0.0.0:3333/
To shutdown the application for local environment cd in to your project directory inside the virtual machine and run.
docker-compose down
All testing databases should automatically migrate and seed When spinning up the application using docker-compose. In the event that it doesn't please follow the following steps.
To run the database migrations you much attach your terminal to the container shell. This can be done by either right clicking on the container named "jarvis_web" in VS Code and selecting "attach shell" in the drop down or running the following command:
docker exec -it <mycontainerid> bash
Once the shell has attached to the container you can run to begin the migration.
adonis migration:done
Every time you shutdown the application container you will have to run the migration again.
Seeding will fill you DB with some valid dummy data.
To run the database seeding you much attach your terminal to the container shell. This can be done by either right clicking on the container named "jarvis_web" in VS Code and selecting "attach shell" in the drop down or running the following command:
docker exec -it <mycontainerid> bash
Once the shell has attached to the container you can run to begin the migration.
adonis seed
One of the containers running alongside jarvis is called adminer. This container serves a tool that allows us to see the contents of the DB. To go to the tool you can visit the following address in your browser.
please note: you should have already ran docker-compose up for this to work
http://0.0.0.0:8080/
You can now use the credential you defined in the .env file to log in as seen in the following image.
In order to successfully merge pull requests you must run ESLint on your project before opening PR.
Step 1: cd into project directory in VM
Step 2: install ESLint globally
npm i -g eslint
Step 3: run ESLint
Run eslint using the --fix flag to automatically fix as much as it can. Please manually correct any errors that it print out.
eslint . --fix
please ignore beyond this point
Install the following in your local environment:
-
Install Node.js here
-
Install Adonis with
yarn add global @adonisjs/cli -
To setup SQLite3, Outlook, and more check out our wiki
- Clone the Jarvis repo
- Set up the .env file based on .env.example
- Run 'docker-compose up"
- Go to
http://0.0.0.0:3333/in the virtual machine browser
For more examples, please refer to the Documentation
Distributed under the MIT License. See LICENSE for more information.
Project Link: https://github.com/CDH-Studio/Jarvis