README.md

Neurologica VR API

Server API for managing VR applications
Explore the docs »

View Latest App · Report Bug

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Architecture
4. Contributing
5. Contact

About The Project

This application was developed to serve as the backend for future VR applications developed by Neurologica VR. The goal of this organization is to provide a unique experience for users to learn various computer science related subjects. This application was specifically built for our first application Visualize Data Structures, a VR application teaching users about data structures and algorithms. This application will offer an immersive learning experience for students or free learners, and a supplementary resource for educators to teach and grade their students. The goals of the project included:

• Developing an application in Unity targeting the Oculus Quest platform
• Developing a Node.js backend application to manage web requests and database
• Developing a website for the organization

(back to top)

Built With

• Unity
• Node.js
• Express.js
• MongoDB
• Bootstrap

(back to top)

Getting Started

Instructions for running the NVR API locally

Prerequisites

• Set up a database at https://mongodb.com
• Set up an account at https://mailgun.com
• Install Node.js and NPM at https://nodejs.org

Installation

1. Clone the repo

   git clone https://github.com/orsoknows/nvr-api.git

2. Install NPM packages

   npm install

3. Rename config.env.env to config.env
4. In config.env...
   1. Enter your MongoDB API key

      MONGO_URI = 'ENTER YOUR MONGODB API KEY';

   2. Enter your Mailgun API key

      MAILGUN_API_KEY = 'ENTER YOUR MAILGUN API KEY';

      1. Enter a JWT secret key

      JWT_SECRET = 'ENTER A JWT SECRET';

5. Run the server in development mode

   npm run dev

(back to top)

Architecture

Database Diagram

Context Diagram

Data Flow Diagram

(back to top)

Contact

Ken Orsini - kto.dev - [email protected]

Brendan Chase - chasevisualsllc.com - [email protected]

Project Link: https://github.com/orsoknows/nvr-api

(back to top)