Skip to content

Latest commit

 

History

History
executable file
·
128 lines (109 loc) · 2.86 KB

README_EN.md

File metadata and controls

executable file
·
128 lines (109 loc) · 2.86 KB

Setup and Guide

Introduction

We are using Meteor.js 3, MongoDB, Redis, React 18, Axios, Zod, Monti APM, Uniform, i18n, Tailwind and FlowBite UI. There are small differences on our approach to Meteor.js. However, learning Meteor.js from its own guide will be enough to contribute.

Requirements

Installation

First of all clone the repository and create your own settings.json file from settings,example.json

### Install dev environment
Run mongodb (replica set) and redis for development environment.
You can meet these requirements with a single command.

```bash 
npm run dev-env

When docker images are up, run the app

npm run start

The app should be available at http://localhost:3001/

You can use meteor command to run the application with its build in mongodb, after disabling redis-oplog

To simulate production use

npm run simulate-production

Test

npm run test
npm run cypress

Deploy

We are using mup to deploy, so check .deploy folder for details

npm run deploy

Packages

Soma of the important packages used in the project.

  • alanning:roles
  • jam:methods
  • jam:pub-sub
  • jam:offline
  • uniforms
  • universe:i18n
  • zod

APM

Monti

Features & Roadmap

  • Authentication
    • Login
    • Register
    • Roles
    • Forgotten password reset
    • Change password
    • 2FA
  • Logging
  • UI/UX
    • Tailwind
    • Flowbite react
    • Mobile-first
    • Responsive
    • Dark mode
  • Forms
    • Uniform with zod bridge
    • Basic form (uniform) components written with Tailwind
    • Basic forms of uniform with translation support
    • Complex form components written with Tailwind
  • Data grid (simple-datatables) component
    • Client side component
    • Server side component
  • Pages
    • Page routing
    • Home page
    • Payment page
    • Profile page
    • Price page
    • Support page
  • Management
    • User management
    • Role management
    • License management
    • Organization management
    • Headless CMS integration
    • RSS Reader
  • Database
    • Completely soft-remove
    • Multi-tenant database partitioning
  • Infrastructure
    • Decoupled module structure
    • Axios implementation
    • Swagger implementation
    • Cron job module
    • Email sending
    • Migration module
    • Performance monitoring with MontiAPM
    • AWS s3 integration
    • PWA
    • Multi-lingual
  • Methods
    • Validated by zod schemas
    • CQRS (Command and Query buses)