{"id":20435989,"url":"https://github.com/octalpixel/kaizen-express-framework","last_synced_at":"2025-09-14T20:21:40.970Z","repository":{"id":103456761,"uuid":"136476132","full_name":"octalpixel/kaizen-express-framework","owner":"octalpixel","description":"Express based framework for Rapid API Development","archived":false,"fork":false,"pushed_at":"2018-07-16T10:00:23.000Z","size":70,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-01-15T19:43:16.955Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/octalpixel.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-06-07T12:45:30.000Z","updated_at":"2018-11-11T13:27:46.000Z","dependencies_parsed_at":null,"dependency_job_id":"b387bdc4-3457-402a-97b1-515bb51404e4","html_url":"https://github.com/octalpixel/kaizen-express-framework","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/octalpixel%2Fkaizen-express-framework","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/octalpixel%2Fkaizen-express-framework/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/octalpixel%2Fkaizen-express-framework/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/octalpixel%2Fkaizen-express-framework/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/octalpixel","download_url":"https://codeload.github.com/octalpixel/kaizen-express-framework/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241982490,"owners_count":20052529,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-15T08:38:47.996Z","updated_at":"2025-03-05T06:41:35.815Z","avatar_url":"https://github.com/octalpixel.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Kaizen Express Framework Alpha\n###### Express based framework for Rapid API Development\n\n# Getting Started\n###### Refer sample PostController if lost xD\n\n\n\nInstall all dependencies\n```\nnpm install\n```\n\nCreating Mongoose Schema\n* Create your desired mongoose scheme in the Model Folder under app\n\nCreating New Controller Class\n* Create class extending the base KDController in the core folder\n* Import created Mongoose Schema\n* Pass the schema to the super class constructor\n\nAdding New Controller to the Application\n* Open app.controller.config.ts\n* Import the newly created Controller\n* Add to the list of export object\n\nCreating Routes\n* Open routes.json\n* Follow the structure in the \"configs\" key to define new route\n```\n   {\n       //Base URL for the current API\n        \"base_url\": \"/api/v1/\",\n        //List of Routes for the current base url\n        \"configs\": [\n            {\n\n                //Path to the current controller\n                \"path\": \"post\",\n                //controller name :  Case Sensitive\n                \"controller\": \"PostController\",\n               \n               /*List of methods that is handled\n                \"request method name\" :  \"function in the controller handing the request method\"\n                Default Available Methods in the KDController\n                get \n                getOne - needs id as params\n                create\n                update - needs id as params\n                delete - needs id as params\n                */\n\n                \"handlers\": {\n                    \"GET\": \"get\",\n                    \"POST\": \"create\"\n                   \n                }\n            }\n        ]\n    }\n```\n\n# Running Server\nOpen terminal and type\n```\nnodemon\n```\nand enter to start dev server\n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foctalpixel%2Fkaizen-express-framework","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foctalpixel%2Fkaizen-express-framework","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foctalpixel%2Fkaizen-express-framework/lists"}