Skip to content

masonitedev/collapsar

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

101 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Collapsar

Collapsar GitHub Workflow Status (branch) PyPI Python Version GitHub release (latest by date including pre-releases) License Code style: black

Introduction

Collapsar is a package that will let you save time creating a dashboard for your app. You won't need to worry anymore about creating CRUD's.

Features

  • Add multiple resources to your dashboard using Masonite Models
  • Use fields: TextField, IdField, PasswordField, SelectField and more
  • Add basic validations: max, min, required, email, etc.

Documentation

See the official documentation to learn how to use Collapsar.

Requirements

  • Python 3.10 – 3.13
  • Masonite 5 (masonite-framework>=5) — Collapsar ≤ 0.0.14 supported Masonite 4 only

Installation

Inside a Masonite 5 application:

pip install collapsar

Configuration

Add CollapsarProvider to your project in config/providers.py:

# config/providers.py
# ...
from collapsar import CollapsarProvider

# ...
PROVIDERS = [
    # ...
    # Third Party Providers
    CollapsarProvider,
    # ...
]

Create a new resource for one of your models:

python craft resource User

This generates app/collapsar/resources/User.py, which Collapsar discovers automatically on boot. Make sure you have at least one user to log in with (you can create one with python craft collapsar:user), then start the server and open the panel:

python craft serve
  • Admin panel: http://localhost:8000/collapsar (redirects to /collapsar/auth/login until you sign in)
  • JSON API used by the panel: http://localhost:8000/collapsar-api/... (auth protected)

Contributing

Please read the Contributing Documentation here.

Maintainers

License

Collapsar is open-sourced software licensed under the MIT license.

About

Collapsar is a tool that allows you to easily create admin panels in Masonite Framework.

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors