Skip to content

eliataylor/object-actions

Repository files navigation

Object-Actions Worksheet

PURPOSE

  • Learn Relational Database Schema Design

  • Quickly build idea App & API prototypes

  • Scaffold Content Management Systems

  • Scaffold Authentication and Access Permissions

  • Scaffold Web App interface and API connectivity

  • Scaffold Cypress.io test suites

  • Generate unlimited fake data to test and prototype

HOW

  • [A] Defined your project's content Objects and the Actions to interact with them
  • [B] Define the fields for each Object type
  • [C] Define the roles and permissions for each Action per Object
A: Objects to Actions B: Object Field Types C: Permissions Matrix
Objects / Actions Objects to Actions Permission Matrix
↓ generates ↓

A secure API and CMS written in Django, with a fully integrated and authenticating ReactJS front-end:

docs/nod-oa-interface.png

Content Admin API Documentation with Secure Authentication System
CMS Admin Swagger Docs Redoc Docs

USAGE:

Generate your Django models, views, serializers and urls:

python django/generate.py admin --types=examples/object-fields-nod.csv --output_dir=examples/django/oaexample_app

Generate your TypeScript types, interfaces and URL patterns:

python django/generate.py typescript --types=examples/object-fields-nod.csv --output_dir=examples/reactjs/src/object-actions/types/types.tsx

Test API and Generate fake data for API

cd databuilder && npm install && npm start

Run Frontend example from object-actions/examples/reactjs:

cd object-actions/examples/reactjs && npm install && npm start

For step-by-step usage to build example projects see USAGE.md


Build your own project from Object/Actions spreadsheets

Copy and start your own from this Empty version.

Or copy and edit this Example version for a meal prep program:


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