Skip to content

Latest commit

 

History

3,354 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Goovee

Goovee is a modern web portal built with Next.js for clients and partners, providing an intuitive and responsive interface for accessing services, managing information, and streamlining collaboration. Check the website goovee.com for more information.

Features

  • Clean and responsive UI built with Next.js
  • Integrated with Goovee ORM
  • Modular and scalable architecture
  • Easily customizable and extensible

Tech Stack

Compatibility Matrix

Goovee Version Compatible Axelor-Portal
v2.0.x 9.0.4+
v2.1.x 9.0.13+, 9.1.2+
v2.2.x 9.0.14+, 9.1.4+
v2.3.x 9.0.15+, 9.1.5+

Goovee 1.x compatibility is maintained on the 1.x-wip branch.

Usage

Here is the project structure:

.
├── app/            # Next.js page routes
├── lib/            # Utilities and helpers
├── goovee/         # Goovee ORM setup and models
├── public/         # Static assets
├── ui/             # Reusable UI components
└── ...

To start the app, run these in order:

  1. Install the dependencies: pnpm i
  2. Copy env.example to .env in the root directory. The settings left uncommented there are the required ones; fill them in.
  3. Confirm the settings are valid: pnpm config:check
  4. Generate the ORM client: pnpm generate
  5. Compile the website stylesheets: pnpm website:sass
  6. Build the project: pnpm build
  7. Start the app: pnpm start

pnpm dev replaces the last two steps with a development server, which serves the app without building it first.

Open http://localhost:3000 with your browser to see the result.

ORM

The application make use of @goovee/orm for data access. Each tenant has its own database, named by that tenant's own variable in .env:

PORTAL_TENANT_<ID>_DB_URL=postgres://<user>:<password>@<host>:<port>/<db-name>

Then, you can define models inside the goovee/schema folder. After each change in the schema folder, you need to re-run the generation command pnpm generate to propagate the changes inside the ORM client.

Check Goovee ORM for more information about its usage.

Documentation

  • CONFIGURATION.md — every setting a deployment carries, written as environment variables or as a JSON file, and how to check them before starting the portal.
  • MIGRATION.md — which runbooks an upgrade needs, by the version being upgraded from.

License

This package is made available under the Sustainable Use License.

You may use this software for non-commercial or internal business purposes only. Commercial use requires a valid Axelor SAS Enterprise License.

See LICENSE.md for details.

Development

Please check out our CONTRIBUTING.md for guidelines.

Contact

For any questions or feedback, feel free to reach out via the contact form on goovee.com or open an issue on this repository.

About

No description, website, or topics provided.

Resources

Contributing

Stars

8 stars

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages