Safety Equipment Inspection App

This project has been built by a group of Computer Science students at John Carroll University in the graduating class of 2023. Its purpose is perform efficient inspections of safety equipment.

Built with:

• .NET 6.0
• Angular
• Firestore
• Google.Cloud.Firestore 3.0

Prerequisites

• Latest version of .NET: can be downloaded here
• npm: Download here
• TypeScript: Find instructions on how to install here
• Google.Cloud.Firestore: a .NET library for working with FireStore documents; installed from the NuGet packages in Visual Studio. Go into Visual Studio, right click the project, choose "Manage NuGet packages..." and search for it.

Getting Started

Here is a quick intro of the steps needs to get the app up and running on your desktop computer.

1. Download a zip folder containing the project, or navigate to a folder in your terminal and run this command

   git clone https://github.com/sierrataylor/safety-equipment-inspection-app.git

   which should clone the repository into a folder of your choice

2. Once you have installed npm, navigate to the folder containing the project

3. Navigate to the folder containing the SafetyEquipmentInspectionApp project and you should find package.json in the root of the project.

   cd <folder_path>/SafetyEquipmentInspection/SafetyEquipmentInspectionApp/

   Run

   npm install package.json

   to install the necessary dependencies.

4. To run the app:

   • Windows: Press F5 in the Visual Studio window to start the application with debugging
   • Mac: Run the application in Visual Studio. In your terminal or command prompt, navigate to the folder containing the source code for the Angular front-end application.

     cd SafetyEquipmentInspection/SafetyEquipmentInspectionApp/ClientApp/src

     Then type this command in the terminal to start the front end before running the application in Visual Studio.

     npm start

   Configuration

   To configure Visual Studio to run both the API and the front-end:

5. Open the application in Visual Studio and right-click the solution file (SafetyEquipmentInspection.sln).

6. Select Select Startup Projects... or Properties.

7. In the Startup Project menu, select Multiple startup projects and at this point you should see both the API and Angular application projects enabled for selection.

8. Select Start as the action for both and click *Apply".

9. Now when you run the project, two windows should open.

   Tests

   to be added