5S Audit App

Overview

5S audits promote more efficient operations. In simple terms, 5S methodology helps keep the workplace organized and clean. This app allows you perform an audit to ensure the 5S approach is followed.

This application is still in development. See Roadmap.

Features

• Create and browse audits
• API: JWT authentication with refresh tokens
• API: Paging, sorting
• API: Security headers

Built with

• React.js - frontend (client)
• Angular - frontend (another client)
• .NET - backend (API)

Getting started

Prerequisites

Make sure you have installed the following prerequisites:

• VS Code (optional but preferred)

• SQLiteStudio (or other software to browse SQLite database)

• Git

git --version
# => git version 2.34.0.windows.1

• Node.js

node --version
# => v20.11.1

npm --version
# => 10.2.4

• .NET SDK

dotnet --version
# => 8.0.111

• EF Core CLI tools

dotnet ef --version
# => 9.0.0

Installation

1. Clone the repository

git clone https://github.com/schwastek/5s-audit-app.git

2. Install npm packages of React

cd client
npm clean-install

3. Or install npm packages of Angular

cd client-angular
npm clean-install

4. Generate SSL certificate for Angular local development

cd client-angular/ssl
dotnet dev-certs https --export-path ./certificate.pem --no-password --trust --format PEM

Running application

When you start ASP.NET Core web API, it won't launch React or Angular client app automatically.
Both frontend and backend must be started manually.

Run React frontend app:

cd client
npm start

Or run Angular frontend app:

cd client-angular
npm start

Run ASP.NET Core web API:

cd Api
dotnet run

In a web browser, navigate to http://localhost:3000 (React) or https://localhost:4200 (Angular).

Log in with email and password:

• [email protected]
• Pa$$w0rd

Usage

Log in

Create new audit

Browse audits

Documentation

API

Please refer to the API docs.

Database

SQLite database file is created in the special "local" folder for your platform.
Use Run command below (WIN+R) to open the "local" folder on Windows: C:\Users\{Username}\AppData\Local.

%LocalAppData%

You can run Api.Data console application to seed database:

Common commands

To manage migrations you can use dotnet ef CLI tools or Package Manager Console.

# Add migration
dotnet ef migrations add MyMigration --project Api.Data --startup-project Api.Data

# Remove last migration
dotnet ef migrations remove --project Api.Data --startup-project Api.Data

# Apply migrations (specify environment)
dotnet ef database update --project Api.Data --startup-project Api.Data -- --environment Development

# Or apply migrations using Package Manager Console
Update-Database -Project Api.Data -StartupProject Api.Data -Args '--environment Development'

Roadmap

• Create audits
• Browse audits
• Login
• Audit actions
• Registration
• Action comments
• Image upload

License

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

Acknowledgments

Resources I find helpful and would like to give credit to:

• Dockx, K. (2019). Building a RESTful API with ASP.NET Core 3. Pluralsight. - Course • GitHub
• Dockx, K. (2020). Implementing Advanced RESTful Concerns with ASP.NET Core 3. Pluralsight. - Course • GitHub
• Resca, S. (2019). Hands-On RESTful Web Services with ASP.NET Core 3. Packt Publishing. - Book • GitHub
• Rippon, C. (2019). ASP.NET Core 3 and React. Packt Publishing. - Book • GitHub
• Cummings, N. (2019). Complete guide to building an app with .Net Core and React. Udemy. - Course • GitHub
• Code Maze (2023). Ultimate ASP.NET Core Web API. - Book