@ztimson/momentum (0.50.0)
Published 2024-11-27 16:32:19 -05:00 by ztimson
Installation
@ztimson:registry=
npm install @ztimson/momentum@0.50.0
"@ztimson/momentum": "0.50.0"
About this package
Table of Contents
About
Momentum is a self-hosted enterprise resource planning tool. What does that mean? Think something similar to Firebase but you are in full control of your data & services.
It was developed as a generic backend to add functionality to single page applications such as angular, react, svelte or vue. Momentum comes with a client library to make integration extremely easy.
Momentum also comes with a management interface to allow easy administration of momentum without having to build anything.
Features include:
- Actions
- Write server side code to create custom functionality
- Writen with javascript & the momentum client library to minimize the learning curve
- Custom library and can be installed & accessed from actions using Docker & NPM
- Trigger actions including CRONs, RESTFUL requests & system events
- Extremely fast
- Authentication
- Manage users with custom values
- Manage groups with cascading permissions & custom values
- Token management for 3rd party applications
- Full permission system which supports custom values
- Account validation & reset emails
- Optional public registration form
- OAuth support for custom applications
- Custom password strength rules
- Two-Factor Authentication
- Data
- Edit database like an Excel table
- Create custom forms & reports to interact with data
- Interact with data through the REST API
- Granular collection & document level permissions
- Automatic metadata tracking
- Easy import/export to CSV, Excel & JSON
- Logs
- Save & view server logs through the UI for easy debugging
- Submit client logs to momentum to aid in remote debugging
- Client logs come with device information such as user agent & screen size
- Storage
- Storage anything with momentum storage
- Built in filebrowser
- Upload & download files with the API
- Full file permissions
- Automatic metadata tracking
- Static File Server
- Host your single page application using Momentum for easy hosting
- Configurable routing
- Settings
- Full theming & white label support
- Manage the server through variables which can be changed at runtime
- Create & use custom variables for your application
- Miscellaneous
- Automatically turn website into Progressive Web App
- Caching & offline support built into the client library
- Socket support to keep all clients in sync automatically
- Generate PDFs from templates, HTML or links
- SMTP support to send emails from templates
- Twilio support to manage texts & calls
- Stripe support to handle payments & subscriptions
Built With
Setup
Production
Prerequisites
Instructions
- Optional: Use momentum to host your static site
- Download the docker-compose file:
curl -o momentum.yaml https://git.zakscode.com/ztimson/momentum/raw/branch/develop/docker-compose.yml
- Configure the Environment Variables inside the docker-compose
- Start the server with:
docker-compose up -f momentum.yaml
- Open http://localhost:80
- Default login:
admin/admin
- Configure System Variables
- Default login:
Development
Prerequisites
Instructions
- Install the dependencies:
npm install
- Start MongoDB:
docker-compose up db
- Start the dev server:
npm run start
- Open http://localhost:3000
- Default login:
admin/admin
- Configure System Variables
- Default login:
License
Copyright © 2024 Zakary Timson | All Rights Reserved
See the license for more information.
Dependencies
Dependencies
ID | Version |
---|---|
@ztimson/utils | 0.22.6 |
var-persist | ^1.0.1 |
Development Dependencies
ID | Version |
---|---|
@types/node | ^22.5.4 |
typescript | ^5.6.2 |
vite | ^5.4.3 |
vite-plugin-dts | ^4.2.1 |
Keywords
Momentum