/ruby_shift_report

Rails and React app hosted with Heroku and AWS Amplify to help generate docx files for shift and incident reports. Solution for security businesses (or others) that need a standard format for report writing.

Primary LanguageJavaScript

[DISCONTINUED]


Shift Report Generator


Seemless Report Generation!

recording

Table of Contents

Introduction

Since the rails backend is not supported any more, this repo exists as a reference to building other Rails JWT Sessions apps

This is a Rails API and React front end built to simply have a user log in with their security officer information, add entries on the events that occurred during their shift, and generate a docx file with those entries included. Great for security companies wanting to automate the report formatting process!

Desktop design focused Main Dashboard Report Writing Page

Hosting

Shift Report is live! -> (WARNING some rails backend features have been discontinued) Shift Report Frontend hosted on AWS Amplify Backend REST API hosted on Heroku

Features

A few of the things you can do with the app:

  • Register a user account with email
  • Create a report
  • Add entries to that report
  • generate a docx file of that report with those entries

Technologies

  • JavaScript
  • React.js
  • ContextAPI
  • MaterialUI
  • VS Code
  • Git and Github
  • Ruby 2.5.6
  • Rails 6
  • PostgreSQL

Build

To build on your own machine

Backend
  • Clone or download the repo
  • Navigate into that repo with cd ruby_shift_report
  • bundle to install gems
  • You will likely have to create a database with rails db:create db:migrate
  • rails s to run the API on localhost
Frontend
  • Navigate to the shift_report_frontend directory in /app/ then run npm install
  • Then run npm start to run the frontend on localhost:3006
  • Open your preffered browser and navigate to http://localhost:3006

Bugs

If the automatic logout alert signals, and you open the app in another broser or tab, the application will be unable to start up

Contact

If you'd like to inquire about any details, or have questions about the technology, feel free to contact me.

Tech owner:

Additional Frontend contributers:

License

  • This software is licence under the MIT license.