Zakary Timson

Repositories

35

Projects Packages Public Activity Starred Repositories

@ztimson/momentum (0.50.1)

Published 2024-12-25 23:02:15 -05:00 by ztimson

Installation

Setup this registry in your project .npmrc file:

@ztimson:registry=

To install the package using npm, run the following command:

npm install @ztimson/momentum@0.50.1

or add it to the package.json file:

"@ztimson/momentum": "0.50.1"

For more information on the npm registry, see the documentation.

About this package

Momentum

Enterprise Record Management

---

Documentation • Release Notes • Report a Bug • Request a Feature

---

Table of Contents

• Momentum
  • About
    • Built With
  • Setup
    • Production
    • Development
  • License

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

• Docker

Instructions

1. Optional: Use momentum to host your static site
2. Download the docker-compose file: curl -o momentum.yaml https://git.zakscode.com/ztimson/momentum/raw/branch/develop/docker-compose.yml
3. Configure the Environment Variables inside the docker-compose
4. Start the server with: docker-compose up -f momentum.yaml
5. Open http://localhost:80
   • Default login: admin/admin
   • Configure System Variables

Development

Prerequisites

• Docker
• Node.js

Instructions

1. Install the dependencies: npm install
2. Start MongoDB: docker-compose up db
3. Start the dev server: npm run start
4. Open http://localhost:3000
   • Default login: admin/admin
   • Configure System Variables

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

Details

npm

2024-12-25 23:02:15 -05:00

0

Zak Timson

50 KiB

Assets (1)

momentum-0.50.1.tgz 50 KiB

Versions (66) View all

0.50.4 2024-12-26

0.50.3 2024-12-26

0.50.2 2024-12-26

0.50.1 2024-12-25

0.50.0 2024-11-27