Skip to content

eliataylor/object-actions

Repository files navigation

Object-Actions Worksheet


PURPOSE

  • Relational Database Schema Design
  • Scaffolding Content Management Systems
  • Scaffolding Authentication and Access Permissions
  • Scaffolding Web App interface and API connectivity
  • Scaffolding Cypress.io test suites
  • Generating unlimited numbers of fake data entries to test

USAGE:

Generate your Django models, views, serializers and urls:

  • git clone [email protected]:eliataylor/object-actions.git
  • cd object-actions
  • python3.9 -m venv .venv (pretty much any version of python should work)
  • source .venv/bin/activate
  • pip install -r requirements.txt
  • python django/generate.py admin --types=examples/object-fields-nod.csv --output_dir=examples/generated

If you use Address, Price, or Coordinates field types, you'll need to add the respective entries to the INSTALLED_APPS list in your settings.py file:

INSTALLED_APPS = [
    # ... 
    'address',
    'django-money',
    'django.contrib.gis',
    # ... 
]

To run a complete CMS, API, with connected ReactJS app follow CONTRIBUTING.md

Getting Started

Copy and start your own from this empty version.

This example version describes an open source platform for rallying citizens to civic engagement called Democrasee (github.com/DemocraseeClub). Screenshots are below:

Object/Actions Object Fields Vocabulary Fields Permissions Matrix

All Select options under Fields Types (Column D) in the Object Fields sheet come from column A in the "selectors" sheet. If you have special field types, add them here. The checkboxes roughly describe what Fields are support by the different CMS config builders in this repository. Field Types

DEVELOPMENT ROADMAP

  • Generate Django Admin CMS
  • Generate Django Restful API with Swagger Docs
  • Generate Fake Data builder via HTTP (https://mockaroo.com/?)
  • Generate ReactJS app
    • TypeScript interface and object types defined
    • Material-UI Drawer of Permissions Matrix Paths
  • Generate Cypress.io test suite
  • AppScrips to generate full Worksheet for given Object-Actions list

To contribute: CONTRIBUTING.md

About

An interactive worksheet and CMS builder

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Sponsor this project

Packages

No packages published