[go: nahoru, domu]

Skip to content

CDH-Studio/Jarvis

Repository files navigation

Build Status Contributors MIT License


Logo

A CDH Studio Room Booking Application
Explore the docs »

Demo · Website/ Screenshots · View Wiki

Table of Contents

About The Project

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)

The Team

Built With

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

Install virtual environment

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:

  1. Download and install Virtual Box from the following link. Last tested version: 6.0

    Oracle Virtual Box

  2. 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

  3. Boot up the VM and test you have network connection. If you are having issue it is often related to proxy settings

  4. If you are having problems with screen resolution and clipboard sharing between Guest and Host OS then please install the Ubuntu Guest additions:

    1. $ sudo apt update
      $ sudo apt upgrade
      $ sudo apt install build-essential dkms linux-headers-$(uname -r)

    2. 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.

    3. Next, you will get a dialog window, prompting you to Run the installer to launch it.

    4. 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.

Install Dev tools

inside the VM you can now install your dev tools. we rommend:

  1. Git
  2. 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.

Install Docker & Docker Composer

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

Other Prerequisites

Install the following in your local enviroment:

  • Install Node.js here

  • Install Adonis with yarn add global @adonisjs/cli

  • To setup SQLite3, Outlook, and more check out our wiki

Installation

  1. Clone the Jarvis repo
  2. Set up the .env file based on .env.example
  3. Run 'docker-compose up"
  4. Go to http://0.0.0.0:3333/ in the virtual machine browser

Screenshots

screenshot1 screenshot2 screenshot3

For more examples, please refer to the Documentation

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Project Link: https://github.com/CDH-Studio/Jarvis

Acknowledgements

About

Simplified room booking web application.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published