REI3

REI3 - the open application platform

Description

REI3 is a Business Management Software that is built on modern web technologies. Open-source, free to use and expandable, anyone can use REI3 to address business software needs.

A growing number of business applications are already available. Track employee time, manage tasks, control assets and much more with REI3 applications. And if those applications do not completely fulfill your requirements: Easily expand them with extra data, business logic and user interfaces.

Also included: The Builder. A graphical, low-code tool to build upon existing or create completely new REI3 applications. With visual form editors but also access to complex data structures and performance optimization features, highly scalable applications are simple to create.

Programming language: JavaScript

License: MIT License

Tags: Self-hosting Solutions     Web Apps     Low Code    

README

REI3

REI3 is a business application platform that anyone can use. It provides access to a growing range of free business applications, which are built with the integrated, graphical application Builder.

Individuals and organizations can freely build on or create completely new applications. Once created, applications can be exported and shared with others via files or public repositories.

⭐ Features

• Easy to install on Windows and Linux systems with very few dependencies.
• Self-hosted or deployable to cloud systems as web-based service.
• Usable free of charge, with no user limit.
• Growing feature set for powerful applications:
  • Complex relationships, joined relation input forms, sub queries and so on.
  • Various frontend components, such as calendars, Gantt plans, color inputs, sliders and many more.
  • Support for complex functions and business rules with general or per-record access control, database triggers and more.
  • Mobile views, with options to optimize frontend components for easier use on small screens.
  • Sending and receiving mails with attachments.
  • Multi-language support.
  • API for read and write access.
• For enterprise environments:
  • LDAP import for user logins and access permissions.
  • Customization of application colors, names, welcome messages and so on.

📀 How to install

Windows

1. Download and execute the installer. If you choose the stand-alone mode, REI3 is automatically configured for you.
2. That´s it.

If you want to use your own database server, you can install REI3 in dedicated mode - visit the admin documentation to learn more.

A portable version is also available for Windows clients for testing and developing applications.

Linux

1. Prepare a PostgreSQL server with a new, empty database.
2. Download and extract the precompiled Linux package.
3. Make the file r3 executable.
4. Rename the file config_template.json to config.json and enter connection details to the chosen database.
5. Install REI3 as a service with r3 -install.
6. Start REI3 with your service manager, as in systemctl start rei3.
7. That´s it.

Example config.json file with connection details

{
        "db": {
                "embedded": false,
                "host": "10.0.150.1",
                "port": 5432,
                "name": "r3_database",
                "user": "r3",
                "pass": "A_STRONG_PASSWORD_PLZ"
        },
        "paths": {
                "certificates": "data/certificates/",
                "files": "data/files/",
                "temp": "data/temp/",
                "transfer": "data/transfer"
        },
        "web": {
                "cert": "cert.crt",
                "key": "cert.key",
                "listen": "0.0.0.0",
                "port": 5443
        }
}

For the full admin documentation, please visit the website.

💡 How to build applications

All versions of REI3 include the graphical Builder utility, which can create new or change existing applications. After installing REI3, an administrator can enable the Builder inside the system configuration page. The maintenance mode must be enabled first, which will kick all non-admin users from the system while changes are being made.

For information about how to use the Builder, please visit the Builder documentation.

📑 How to build your own version of REI3

1. Install the latest version of Golang.
2. Download & extract the source code of the version you want to build (as in 2.4.3.2799).
3. Go into the source code directory (where r3.go is located) and execute: go build -ldflags "-X main.appVersion={YOUR_APP_VERSION}".
   • Replace {YOUR_APP_VERSION} with the version of the extracted source code. Example: go build -ldflags "-X main.appVersion=2.5.1.2980"
   • You can change the build version anytime. If you want to upgrade the major/minor version numbers however, you need to deal with upgrading the REI3 database (see db/upgrade/upgrade.go).
   • By setting the environment parameter GOOS, you can cross-compile for other systems (GOOS=windows, GOOS=linux, ...).
   • Since REI3 2.5, static resource files (HTML, JS, CSS, etc.) are embedded into the binary during compilation.
4. Use your new, compiled binary of REI3 to replace an already installed one.
5. You are now running your own version of REI3.

📇 Technologies

The REI3 server application is built on Golang with the frontend primarily based on Vue.js. By using modern web standards, REI3 applications run very fast (cached application schemas, data-only websocket transfers) and can optionally be installed as progressive web apps (PWA) on client devices.

REI3 heavily relies on PostgreSQL for data management, storage and backend functions.

👏 How to contribute

Contributions are always welcome - feel free to fork and submit pull requests.

REI3 follows a four-digit versioning syntax, such as 2.4.2.2788 (MAJOR.MINOR.PATCH.BUILD). Major releases serve to introduce major changes to the application. Minor releases may bring new features, database changes and fixes. Patch releases should primarily focus on fixes, but may include small features as long as the database is not changed.

The branch main will contain the currently released minor version of REI3; patches for this version can directly be submitted for the main branch. Each new minor release will use a separate branch, which will merge with main once the latest minor version is released.