eliataylor / object-actions

An interactive worksheet and CMS builder
Other
0 stars 3 forks source link

Object-Actions Worksheet


PURPOSE

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.

This Example version describes a simple ecommerce project for a meal prep program:

Objects / Actions Objects to Actions
Object Field Types Object Field Types
Permission Matrix Permissions Matrix
------------------------------------------ ↓ generates ↓ ------------------------------------------
Interface Demo Interface
CMS Admin CMS Admin
Swagger Docs Swagger Docs
Redoc Docs Redoc Docs

To contribute: CONTRIBUTING.md