Skip to content

eliataylor/objects-actions

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Object-Actions Worksheet

WHY

  • Document your Idea and Database
  • Quickly scaffold scalable Apps & APIs. Including:
    • Authentication with Email, SMS, and nearly every social network
    • Access Controls for User Groups and content ownership context
    • Web App interface with API connectivity
    • Complete End-To-End tests for functionality and content permissions
    • Data generator to create unlimited content data to test and prototype, and the base data for your Cypress tests

HOW

1: Define your Fields for each Object Type 2: Define your roles and permissions
Objects to Actions Permission Matrix

docker-compose up --build

↓ Generates this whole stack ↓

load-form.cy.ts.mp4
Content Admin API Docs Front-End WebApp
CMS Admin Swagger Docs WebApp

Build a scalable, secure API and CMS in Django, a fully integrated and authenticating ReactJS web app, end-to-end tests with Cypress.io and API load tests with K6. Includes OAuth logins from Google, Facebook, Spotify, SMS, and pretty much social network that provides OAuth.

TO RUN:

  • git clone [email protected]:eliataylor/object-actions.git
  • cd object-actions
  • docker-compose up --build

TO BUILD:

  1. Copy and customize your own worksheets from this Empty version or this populated Example version:
  2. Download your Object Fields and set the TYPES_PATH in your .env
  3. Download your Permissions Matrix and set the PERMISSIONS_PATH in your .env
  4. Run ./load-sheets.sh --env .env (or reference your own .env.myproject)
  • If you want to build from source follow FROMSOURCE.md
  • If you already have a codebase and only want to generate TypeScript or Django code visit COMMANDS.md to generate individual files

TO EXTEND:

  1. Update any settings you the .env file
  2. ./clone.sh --env .env this will clone the entire stack to STACK_PATH
  3. cd STACK_PATH
  4. docker-compose up --build

TO CONTRIBUTE: CONTRIBUTING.md


Example Site: https://oaexample.com/readme readme.png

Offer Sign-in / Sign-up from any of these AllAuth Providers sign-in-page.png

About

An interactive worksheet and CMS builder

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published