Code Monkey home page Code Monkey logo

crudcast's Introduction

crudcast

Crudcast lets you build a fully functioning and OpenAPI-compliant CRUD API with a few lines of YAML code. It lets you create a fully-functional web app backend for prototyping purposes

Installation

Crudcast requires mongodb - install and start as follows:

brew install mongodb
brew service start mongodb

Install crudcast

pip install crudcast

Create a config file, config.yml, in the same folder

models:
  person:
    fields:
      first_name:
        required: true
      last_name:
        required: true
      age:
        type: number

Usage

CD into the folder containing your config.yml, and run this command

crudcast

Go to http://localhost:5000/api/docs to see your documented and fully-functional API

Documentation

Coming soon.

Roadmap

Crudcast is brand new and only has a small percentage of the intended functionality so far. In future, I am planning to add support for:

  • user management and authentication (basic, token-based and social)
  • permissions
  • inserting your own code - either for validation, permissions or creating your own methods

If there is any other functionality you'd like to see added, then please raise an issue

crudcast's People

Contributors

chris104957 avatar

Watchers

James Cloos avatar .- ... .--. .. .-. .. -. --. --. ..- .-. ..- avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.