Voyager

A better way to manage the bureaucracy of PCS'ing

Report Bug

·

Request Feature

Table of Contents

1. About The Project

   • Built With

2. Getting Started

   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

We would like to reduce the amount of actual work and guess work currently involved in the in/out-processing process, by allowing computers to do the tedious work.

Allowing you to focus on what you actually need to do and help you do it.

(back to top)

Built With

Primary Packages and Libraries

• React
• Vite
• Express
• Prisma

Supporting Packages and Libraries

• React Router
• MUI
• Firebase
• Recharts

(back to top)

Getting Started

Prerequisites

1. Docker must be installed on the system at a minimum. While the server and user interface can be spun up manually, the database requires docker for installation)

2. A Firebase Account with:

   • A Project set up under your Firebase account
   • Authentication set up configured for Email/Password Authentication
   • Knowledge of your Firebase project's private key (see Project Settings)
   • See Firebase Docs on admin setup

(back to top)

Installation

As a User

Navigate to: https://bsdi1-voyager-frontend.herokuapp.com

As Developer

1. Clone the Voyager Repo
   • Example: git clone git@github.com:Th3Whit3Wolf/voyager.git
2. Navigate into the repo
   • Example: cd voyager
3. Add firebase private key to .secrets
   • Per the prerequisites, you should already have a Firebase project and your private key
   • Copy your key into .secrets from the project root directory
   • Create a .env file with FIREBASE_PATH set to the name of the file you added to the .secrets directory

     mkdir .secrets
     cat <<  EOF > .env
     FIREBASE_PATH="firebaseVoyagerDev.json"
     EOF
     mv firebaseVoyagerDev.json .secrets

4. From the voyager root directory, start up Docker compose npm run docker:up
5. Set up the database schema and initialize with seeds

   cd backend
   npm run db:reset
   cd ..
   

6. Open a new browser and navigate to http://localhost:3000
7. To spin the application back down use npm run docker:down

Note: If there are errors trying to get the application to load after spinning it up in step 4, then some Developers may have to do some steps manually:

• IF there are errors, then some Developers may have too: - First, make sure all Docker containers are down with npm run docker:down - Second, remove all Docker voyager images - Then do the following steps

  cd frontend
  npm install
  cd ../backend
  npm install
  cd ..
  npm run docker:up
  cd backend npm run db:reset
  	(select yes with "y" option)
  cd ..
  

(back to top)

Usage

(back to top)

License

License distribution is based upon the various packages used in the development. The primary packages used in this project are provided at the beginning of this ReadMe document.

(back to top)