Scaffold

Description

Real-time web app which includes:

• Authentication
• Users management
• Email sendings
• TLS configuration for production
• HTTP Security Headers (Helmet)
• Endpoint tests
• CI Pipeline for GitHub Actions

Additional apps:

• Digital Signature

Applies concepts like:

• Architecture patterns (N-Layers, Server-Client)
• Design patterns
  • Creational
    • Factory
    • Singleton
  • Structural
    • Facade
  • Behavioral
    • Observer (Publish/Subscribe)
• Role Based Access Control (RBAC)

Tech stack: Meteor (Node.js), MongoDB, Vue, Vuetify, TypeScript, Mocha.

Supported Platforms

• macOS 12+
• Linux
• Windows 10+

System Requirements

• Node 22+ download here
• Yarn 1.22.0+
• Meteor 3.3.2 Installation
• Mongo 7.0.4 and Mongo Booster
• Note: In some cases it is necesary to disable antivrus in order to works SMTP Server

Installation

• Clone the last version of the repository here
• Verify you are on dev branch

Database configuration with terminal

Note: For Windows Systems verify that mongo is configured as environment system variable.

1. Open a terminal in the project root
2. Restore the database with:

mongorestore --db theory-swe ./database/theory-swe

Run the backfills:

yarn backfill <backfill_name>

Available backfills:

• RefreshPermissionsBackfill
• RefreshStaticProfilesBackfill

The following commands are only for support:

• Export a backup of the database (data exported as formats BSON and JSON):

mongodump --db theory-swe --out ./database/

Installing dependencies

• Run the following commands to install the dependencies:

yarn

Configure environment variables file (Optional)

Go to ./settings/ and copy settings-development-example.json to settings-development.json and modify the following:

• MAIL_URL:

For development environment.

Install mailpit:

brew install mailpit

Start mailpit as a service:

brew services start mailpit

For production environment: Update the connection string according to your smtp credentials.

Running project

On Mac OS X and Linux

• Run the following commands:

yarn run:mac

On Windows

• Run the following commands:

SET MONGO_URL=mongodb://localhost:27017/theory-swe
yarn run:windows

Usage

User to login:

• Username/Email: admin or admin@example.com
• Password: Theory_5w3