autocrud

command module
v0.1.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 20, 2025 License: MIT Imports: 6 Imported by: 0

README

Autocrud

Automatically generate REST APIs

TODO V0.1.0

  • parse yaml schema.
  • validate yaml schema.
  • create sqlite db from yaml schema with a simple resource. only types available will be INT, VARCHAR, TIMESTAMP, VARTEXT
  • write test for codegen.
  • workout absolute path for codegen templates.
  • rest api to create and read a single resource:
    • create resource from a single table.
    • read resource from a single table.
  • rest api to update and delete a single resource:
    • update resource from a single table.
    • delete resource from a single table.
  • add DTO type.
    • Config should include type info: primary key, default for insert date, default for update date.
    • Use this info from config to create the DTO types
  • getAll frontend: list view with option to add or delete entry.
  • use zod to validate inputs.
  • add notification system.
  • cmd: autocrud [-f --file <config.yaml>] [-t --template]
  • Release Autocrud v0.1.0.
  • Add generated by version comment on all templates.
  • Add build instructions to README.md

TODO future

  • getById frontend with edit option.
  • add proper loggin.
  • parse yaml schema for relational tables.
  • search items in getAll view
  • get names for backend frontend and database directories from config.
  • make generate DB optional
  • database backend interface
    • postgress db in docker
    • duckDB
  • dockerize API
  • dockerize frontend
  • add other django backend.
  • add other views in frontend: eg cards, complex tables, images
  • add migrations table and go script for migrations

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
src
cmd

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL