{"id":18336935,"url":"https://github.com/gogolcorp/go-gadgeto","last_synced_at":"2025-04-09T19:56:49.933Z","repository":{"id":38298402,"uuid":"351031877","full_name":"gogolcorp/go-gadgeto","owner":"gogolcorp","description":"A CLI to initialize and work on go projects, mainly designed for API's.","archived":false,"fork":false,"pushed_at":"2023-04-04T19:02:56.000Z","size":838,"stargazers_count":2,"open_issues_count":15,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-09T19:56:45.129Z","etag":null,"topics":["api","cli","framework","go","golang","starter-kit"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/gogolcorp.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","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":"2021-03-24T10:10:13.000Z","updated_at":"2022-12-29T01:19:38.000Z","dependencies_parsed_at":"2024-06-20T03:02:03.807Z","dependency_job_id":"f75505b6-cd47-470a-b632-61edb2ad53f5","html_url":"https://github.com/gogolcorp/go-gadgeto","commit_stats":null,"previous_names":["edwinvautier/go-cli","edwinvautier/go-gadgeto"],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gogolcorp%2Fgo-gadgeto","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gogolcorp%2Fgo-gadgeto/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gogolcorp%2Fgo-gadgeto/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gogolcorp%2Fgo-gadgeto/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gogolcorp","download_url":"https://codeload.github.com/gogolcorp/go-gadgeto/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248103910,"owners_count":21048245,"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":["api","cli","framework","go","golang","starter-kit"],"created_at":"2024-11-05T20:09:31.747Z","updated_at":"2025-04-09T19:56:49.917Z","avatar_url":"https://github.com/gogolcorp.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# go-gadgeto\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"assets/logo.jpg\" width=\"300\"/\u003e\n\u003c/p\u003e\n\n---\n\n[![Codacy Badge](https://api.codacy.com/project/badge/Grade/9a71350a5de64095a7f175170fc81137)](https://app.codacy.com/gh/edwinvautier/go-gadgeto?utm_source=github.com\u0026utm_medium=referral\u0026utm_content=edwinvautier/go-gadgeto\u0026utm_campaign=Badge_Grade_Settings)\n[![Go](https://github.com/edwinvautier/go-gadgeto/actions/workflows/go.yml/badge.svg)](https://github.com/edwinvautier/go-gadgeto/actions/workflows/go.yml)\n[![CodeQL](https://github.com/edwinvautier/go-gadgeto/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/edwinvautier/go-gadgeto/actions/workflows/codeql-analysis.yml)\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n![version](https://img.shields.io/badge/version-0.0.11-orange)\n[![Go Reference](https://pkg.go.dev/badge/github.com/edwinvautier/go-gadgeto.svg)](https://pkg.go.dev/github.com/edwinvautier/go-gadgeto)\n[![codecov](https://codecov.io/gh/edwinvautier/go-gadgeto/branch/main/graph/badge.svg?token=1USTLF2NA0)](https://codecov.io/gh/edwinvautier/go-gadgeto)\n\n\u003cdiv align=\"center\"\u003e\n  \u003cimg src=\"https://gh-readme-contrib.herokuapp.com/api/edwinvautier/go-gadgeto\"/\u003e  \n\u003c/div\u003e\n\nA CLI to initialize and work on go projects, mainly designed for API's. \n\nIt allows you to auto init your project with a docker configuration, generate your own model files, controllers, fixtures...\n\n## Table of contents\n\n- [Install CLI](#install-cli)\n- [Initialize a project](#initialize-a-project)\n- [Install a bundle](#install-a-bundle)\n- [Update command](#update-command)\n- [Make command](#make-command)\n  - [Make a model](#make-new-model)\n  - [Make CRUD](#make-crud)\n  - [Make fixtures](#make-fixtures)\n  - [Make tests](#make-tests)\n\n## Install CLI\n\n\u003e💡 You need to have go installed correctly on your machine. More informations are available in the wiki.\n\nInstall the CLI by running :\n\n```sh\ngo get github.com/edwinvautier/go-gadgeto\n```\n\nRun `go-gadgeto -h` in order to know more about commands.\n\n## Initialize a project\n\nYou can initialize a project in your working directory by running the `create` command.\n\n```sh\ngo-gadgeto create\n# or with app name\ngo-gadgeto create my-app-name\n```\n\nThe CLI will eventually ask you your **git username**, the **DB management system** you'd like to use and if you want to **dockerize** the application or not.\n\n## Install a bundle\n\nYou can install bundles by using the install command of the CLI.\nThis command will look for a bundle located inside the bundles folder of the repository and install it.\n\n```sh\ngo-gadgeto install authenticator\n```\n\n### Bundle API\n\nEach bundle should have the following elements :\n\n- `templates` folder\n- `install.sh` script\n- `README.md` file to explain how bundle works and how to use it\n\nThe templates part must follow the same filetree as the project that is created.\n\n## Update command\n\n**go-gadgeto** reads the `.go-gadgeto-config.yml` in order to generate your models and other files. If you've created new models and want to update the config file you can run:\n\n```sh\ngo-gadgeto update\n```\n\n## Make command\n\nThe make command generates files with automatic recognition of your fields.\n\n### Make new model\n\nWith **go-gadgeto**, you can use the `make model` command. It will create a new model and repository file with fields of your choice !\n\n```sh\ngo-gadgeto make model modelYouWant\n```\n\n---\n\n### Make CRUD\n\n**go-gadgeto** can generate your controllers, to do so, you just have to use the `make crud` command :\n\n```sh\ngo-gadgeto make crud modelName\n```\n\n**go-gadgeto** will eventually asks you to run the `go-gadgeto update` command, that reads the models files, and parse their fields to the config.\n\n---\n\n### Make fixtures\n\n**go-gadgeto** can generate your fixtures, to do so, you just have to use the `make fixtures` command :\n\n```sh\ngo-gadgeto make fixtures modelName\n```\n\n**go-gadgeto** will eventually asks you to run the `go-gadgeto update` command, that reads the models files, and parse their fields to the config.\n\n---\n\n### Make tests\n\n\u003e Only works with models files for the moment.\n\n**go-gadgeto** can generate your tests, to do so, you just have to use the `make tests` command :\n\n```sh\ngo-gadgeto make tests modelName\n```\n\n**go-gadgeto** will eventually asks you to run the `go-gadgeto update` command, that reads the models files, and parse their fields to the config.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgogolcorp%2Fgo-gadgeto","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgogolcorp%2Fgo-gadgeto","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgogolcorp%2Fgo-gadgeto/lists"}