RevoGrid Pro Starter Kit: Basics

RevoGrid Pro’s docs

Welcome to the RevoGrid Pro documentation! This guide is designed to help you understand and utilize the advanced features of RevoGrid Pro. We are going to provide you with the tools and knowledge needed to build complex, high-performance grid applications.

What You Will Find Here

The RevoGrid Pro documentation is created to assist you in mastering the more sophisticated aspects of our grid framework. Our goal is to:

1. Save Integration Time: Provide you with comprehensive examples and documentation to streamline the integration of advanced features into your grid applications.
2. Offer Pro-Level Examples: Present real-world examples that demonstrate how to implement complex Pro-level features effectively.
3. Enhance Customization: Show you how to extend our existing plugins and create your own custom functionalities to suit your specific needs.
4. Enable Advanced Understanding: Open up the Grid Core functionality and provide deep insights for those who are interested in customizing and extending the grid at a fundamental level.

What We Provide

To ensure you make the most out of RevoGrid Pro, we offer a range of resources and support:

• ✅ Access to All Pro Examples, Plugins, and Documentation: Detailed guides, examples, and plugins exclusive to the Pro version.
• ✅ Prioritized GitHub Issues and Pull Requests: Expedited handling of your GitHub issues and pull requests.
• ✅ Prioritized Roadmap Items and Feature Requests: Influence the future development of RevoGrid by prioritizing your feature requests and roadmap items.

What You Can Do

With RevoGrid Pro, you can take advantage of advanced features and functionalities that enhance your grid application:

1. Explore Advanced Plugins: Use our Pro-exclusive plugins to add sophisticated capabilities to your grid. Each plugin comes with its own set of documentation and examples.
2. Customize and Extend: Leverage our core functionality to build and integrate custom features. The documentation will guide you through extending existing plugins or creating new ones from scratch.
3. Implement Complex Features: Learn how to utilize advanced grid features such as cell merging, custom row operations, formula support, and more. Our examples will provide step-by-step instructions to help you integrate these features into your application.
4. Optimize Performance: Access best practices and optimization tips to ensure that your grid performs efficiently, even with complex configurations and large datasets.

Getting Started

Most of the information you need can be found in our official documentation: RevoGrid Documentation. We suggest to start with key concepts from main docs. Or you can simply jump to the available features, plugins, and examples. In this Pro examples, we aim to provide you with additional tips and insights that will help you effectively manage your data.

🚀 Project Structure

This project combines an Astro portal for showcasing and managing RevoGrid Pro with a Pro Plugin Build, infrastructure, and Docker support. Inside of the project, you'll see the following folders and files:

.
├── .github/
├── .history/
├── angular/
├── astro-portal/
│   ├── .astro/
│   ├── dist/
│   ├── node_modules/
│   ├── overrides/
│   ├── public/
│   ├── src/
│   ├── .env.runtime
│   ├── .gitignore
│   ├── astro.config.mts
│   ├── auth.config.mjs
│   ├── ec.config.mjs
│   ├── package.json
│   ├── README.md
│   ├── svelte.config.js
│   ├── tailwind.config.mjs
│   └── tsconfig.json
├── migrations/
├── node_modules/
├── release/
│   ├── node_modules/
│   ├── plugins/
│   ├── package.json
│   ├── tsconfig.json
│   ├── typedoc.json
│   └── vite.config.ts
├── stripe-webhook/
├── verdaccio/
├── .dockerignore
├── .env
├── .gitignore
├── .prettierrc
├── docker-compose.prod.yml
├── docker-compose.yml
├── Dockerfile
├── package-lock.json
├── package.json
└── README.md

astro-portal/:

The main Astro portal you can access at pro.rv-grid.com.

Project looks for .md or .mdx files in the astro-portal/src/content/docs/ directory. Each file is exposed as a route based on its file name.

It contains the following:

• .astro/ - Astro internal build artifacts.
• dist/ - Compiled output files after the portal build.
• node_modules/ - Project dependencies.
• overrides/ - Custom overrides for dependencies or configurations.
• public/ - Static files served by Astro.
• src/ - Source code for the portal, including components, assets, and configuration files.

release/ - The Pro Plugin Build workspace. Users can explore this folder for the source code of plugins to understand the available modifications.

• plugins/ - Source code for customizable plugins.
• vite.config.ts - Build configuration for the Pro plugins.
• typedoc.json - Documentation configuration for plugin development.

migrations/ Contains database migration files for setting up and managing the PostgreSQL database schema.

stripe-webhook/ A separate microservice for handling Stripe webhooks, built as part of the project infrastructure.

verdaccio/ Configuration for a private NPM registry (Verdaccio) to manage internal package distribution.

Infrastructure and Helpers

• docker-compose.yml and docker-compose.prod.yml - Compose files to set up and run the entire project infrastructure using Docker.
• Dockerfile - Multi-stage build Dockerfile for the Astro portal and plugin builds.
• .dockerignore - Specifies files to exclude when building the Docker image.

Miscellaneous Files

• .env - General environment variables for the project.
• .gitignore - Files and folders ignored by Git.
• README.md - Project documentation.
• package.json and package-lock.json - Node.js dependency management.

This structure ensures clear separation between the portal, plugin development, and supporting infrastructure, making it easier for users and developers to navigate and extend the project.

🧞 Commands

All commands are run from the root of the project, from a terminal:

Command	Action
npm install	Installs all dependencies
npm run dev	Starts local dev server at localhost:4321
npm run build:portal	Build production site to ./astro-portal/dist/
npm run preview	Preview your build locally, before deploying
npm run build:plugin	Build pro version plugins to ./release/dist/

👀 Want to learn more?

Check out RevoGrid Pro’s docs, read the RevoGrid documentation.