{"id":17712570,"url":"https://github.com/the-finding-labs/snugger","last_synced_at":"2025-08-31T05:37:28.790Z","repository":{"id":258804491,"uuid":"875355420","full_name":"The-Finding-Labs/snugger","owner":"The-Finding-Labs","description":"CLI tool to create express API projects with typescript","archived":false,"fork":false,"pushed_at":"2024-10-28T19:19:23.000Z","size":358,"stargazers_count":2,"open_issues_count":4,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-05-08T16:55:25.615Z","etag":null,"topics":["backend-template","cli","command-line-tool","express","javscript","typescript"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/snugger","language":"TypeScript","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/The-Finding-Labs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"docs/CONTRIBUTING.md","funding":null,"license":"LICENSE","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":"2024-10-19T18:49:31.000Z","updated_at":"2024-10-28T19:19:27.000Z","dependencies_parsed_at":"2024-10-24T09:57:35.625Z","dependency_job_id":null,"html_url":"https://github.com/The-Finding-Labs/snugger","commit_stats":null,"previous_names":["the-finding-labs/snugger"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/The-Finding-Labs%2Fsnugger","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/The-Finding-Labs%2Fsnugger/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/The-Finding-Labs%2Fsnugger/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/The-Finding-Labs%2Fsnugger/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/The-Finding-Labs","download_url":"https://codeload.github.com/The-Finding-Labs/snugger/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253112075,"owners_count":21856070,"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":["backend-template","cli","command-line-tool","express","javscript","typescript"],"created_at":"2024-10-25T09:05:36.303Z","updated_at":"2025-05-08T16:55:33.894Z","avatar_url":"https://github.com/The-Finding-Labs.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n\u003cimg src=\"./docs/snugger-logo.png\" alt=\"snugger logo\" width=\"200\"/\u003e\n\u003c/p\u003e\n\n##\n\n\u003ch1 align=\"center\"\u003e\n\u003ca href=\"https://www.npmjs.com/package/snugger\"\u003e\n  \u003cimg src=\"https://img.shields.io/npm/v/snugger.svg\" alt=\"npm version\"\u003e\n\u003c/a\u003e\n\u003ca href=\"https://github.com/The-Finding-Labs/snugger/blob/main/LICENSE\"\u003e \n  \u003cimg src=\"https://img.shields.io/github/license/The-Finding-Labs/snugger\"/\u003e\n\u003c/a\u003e\n\u003c!--\u003ca href=\"https://github.com/The-Finding-Labs/snugger/actions\"\u003e --\u003e\n\u003c!--  \u003cimg alt=\"GitHub Actions Workflow Status\" src=\"https://img.shields.io/github/actions/workflow/status/The-Finding-Labs/snugger/.github%2Fworkflows%2Fbuild.yml\"\u003e--\u003e\n\u003c!--\u003c/a\u003e--\u003e\n\u003c/h1\u003e\n\nSnugger is a simple and lightweight library for generating type-safe API project with [Express](https://expressjs.com/). It is designed to help you quickly build a RESTful API project with [TypeScript](https://www.typescriptlang.org/).\n\nIt is named Snugger because it technically means \u003ci\u003eTightly fit\u003c/i\u003e and it is designed to be easy to use and not add unnecessary complexity to your project.\n\n---\n\n## ⚙️ Installation\n\nIf you do not have Node installed on your device, you are required to install it to run this tool.\n\nYou can install Snugger CLI using npm:\n\n```bash\nnpm install -g snugger@latest\n```\n\nAdditionally you can use yarn to install Snugger CLI:\n\n```bash\nyarn add -g snugger@latest\n```\n\n## ⚡Usage\n\nTo create a new Snugger project:\n\n```bash\nsnugger create\n```\n\n```bash\n\n-| Snugger CLI |-\n\nSnugger v1.0.1 - A CLI for generating type-safe express APIs\n\nEnter project name: [your-project-name]\n\nWould you like to install dependencies? [y/n]\n\n```\n\nor\n\nTo get help and see all the flags:\n\n```bash\nsnugger help\n```\n\nAfter creating the project run this:\n\n```bash\ncd \u003cyour-project-name\u003e\n\nnpm run dev\n```\n\nIt will run your Express Typescript App.\n\n\u003c!--\u003cp align=\"center\"\u003e--\u003e\n\u003c!--  \u003cimg src=\"https://github.com/user-attachments/assets/c7d06b42-bad8-46ec-9301-c4b0c1b637b9\" /\u003e--\u003e\n\u003c!--\u003c/p\u003e--\u003e\n\nSnugger generates the starting files for your project. You can configure your project folder and files according to your requirements.\n\nTo set up your project further, refer to the [Express Official docs](https://expressjs.com/)\n\n## 🔷 Example\n\nIf you run a command like:\n\n```bash\nsnugger create\n```\n\n```bash\n-| Snugger CLI |-\n\nSnugger v1.0.1 - A CLI for generating type-safe express APIs\n\nEnter project name: express-typescript-api\n\nWould you like to install dependencies? yes\n\n```\n\nIt will create a new project in a directory named `express-typescript-api` with `package.json` like this :\n\n```bash\n{\n  \"name\": \"express-typescript-api\",\n  \"version\": \"1.0.0\",\n  \"main\": \"index.js\",\n  \"scripts\": {\n    \"test\": \"echo \\\"Error: no test specified\\\" \u0026\u0026 exit 1\",\n    \"dev\": \"nodemon --exec ts-node app.ts\",\n    \"build\": \"tsc\",\n    \"start\": \"node dist/app.js\"\n  },\n  \"keywords\": [],\n  \"author\": \"\",\n  \"license\": \"ISC\",\n  \"description\": \"\",\n  \"dependencies\": {\n    \"cors\": \"^2.8.5\",\n    \"dotenv\": \"^16.4.5\",\n    \"express\": \"^4.21.1\",\n    \"mongoose\": \"^8.7.2\"\n  },\n  \"devDependencies\": {\n    \"@types/express\": \"^4.17.17\",\n    \"@types/cors\": \"^2.8.17\",\n    \"@types/node\": \"^20.6.0\",\n    \"ts-node\": \"^10.9.2\",\n    \"typescript\": \"^5.6.3\"\n  }\n}\n```\n\n\u003c!-- Please refer to [USAGE.md](docs/USAGE.md) for more detailed usage instructions. --\u003e\n\n## 👥 Contributing\n\nWe welcome contributions! Please see [CONTRIBUTING.md](docs/CONTRIBUTING.md) for details on how to contribute to this project.\n\n## 📜 License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthe-finding-labs%2Fsnugger","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthe-finding-labs%2Fsnugger","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthe-finding-labs%2Fsnugger/lists"}