Project Architecture

This project is a line-of-business app with a front-end, api middle tier and a postgres database back-end.

The sole purpose is to create data in the front-end and to deliver it to the back-end and vice-versa.

Technologies

• HTML/CSS/JavaScript
• Fastify - Api
• JSON Schema - Fastify Validation
• Postgres - Database
• VueJS - Frontend UI
• Vitest - Testing

Project File Structure:

The project will have the api and client folder for the main deliverables, and a packages folder for any additional custom npm modules used in the project.

The api project will be a simple yet powerful restApi that uses a services architecture.

• The index.js file will set up the server and serve the API routes.
• The router.js file will aggregate the routes from the files in the /routes folder using the fastify-plugin architecture (where each file in /routes is a fastify plugin defining CRUD routes)
• The /database folder will contain the schema.sql file, which will define the creation of the postgres database schema.
• IMPORTANT: THE /database/schema.sql FILE IS THE SOURCE OF TRUTH FOR ALL DATA MODEL STRUCTURES!
• The /database/seed.sql has all of the data required for a minimal database setup - (users, permissions, settings, etc.).
• Each 'fastify plugin' will exist in a module with an 'Api' and a 'Service' file.
  • The API file has a naming convetion based on the parent folder (e.g.: bizcards/bizcardsApi.js and bizcards/bizcardsService.js)

File Structure Example:

.
├─ api
│  ├─ database
│  │  ├─ schema.sql
│  │  └─ seed.sql
│  ├─ modules
│  │  ├─ bizcards
│  │  │  ├─ bizcardsApi.js
│  │  │  └─ bizcardsService.js
│  │  ├─ useraccounts
│  │  │  ├─ useraccountsApi.js
│  │  │  └─ useraccountsService.js
│  │  └─ (...additional modules)
│  ├─ schema
│  │  └─ (...fastify schema files)
│  ├─ services
│  │  └─ (...service files)
│  ├─ utils
│  │  └─ (...utility files)
│  ├─ index.js
│  ├─ router.js
│  ├─ server.config.js
│  └─ package.json
├─ client
│  ├─ src
│  ├─ styles
│  └─ package.json
├─ packages
│  ├─ packageA
│  │  ├─ src
│  │  └─ package.json
│  └─ packageB
│     ├─ src
│     └─ package.json
└─ package.json