{"id":15022224,"url":"https://github.com/abayo-luc/generate-node-project","last_synced_at":"2025-04-12T06:17:18.018Z","repository":{"id":36300890,"uuid":"223142552","full_name":"abayo-luc/generate-node-project","owner":"abayo-luc","description":"Bootstrap  a complete NodeJS App with babel, jest, Sequelize, JWT, GithHub action and docker already configured for you. ","archived":false,"fork":false,"pushed_at":"2024-09-14T09:45:28.000Z","size":1036,"stargazers_count":14,"open_issues_count":3,"forks_count":4,"subscribers_count":4,"default_branch":"main","last_synced_at":"2024-10-01T05:42:32.561Z","etag":null,"topics":["docker","github-actions","javascript","jest","node","nodejs"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/generate-node-project","language":"JavaScript","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/abayo-luc.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-11-21T09:57:04.000Z","updated_at":"2024-08-19T20:35:04.000Z","dependencies_parsed_at":"2024-09-24T21:21:03.301Z","dependency_job_id":null,"html_url":"https://github.com/abayo-luc/generate-node-project","commit_stats":{"total_commits":55,"total_committers":6,"mean_commits":9.166666666666666,"dds":0.2909090909090909,"last_synced_commit":"47763e63ccaece9dd7f711ec3c6c64357fbc9cfc"},"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/abayo-luc%2Fgenerate-node-project","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/abayo-luc%2Fgenerate-node-project/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/abayo-luc%2Fgenerate-node-project/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/abayo-luc%2Fgenerate-node-project/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/abayo-luc","download_url":"https://codeload.github.com/abayo-luc/generate-node-project/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":219848753,"owners_count":16556331,"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":["docker","github-actions","javascript","jest","node","nodejs"],"created_at":"2024-09-24T19:57:39.986Z","updated_at":"2024-10-14T04:20:54.501Z","avatar_url":"https://github.com/abayo-luc.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![wakatime](https://wakatime.com/badge/github/abayo-luc/generate-node-project.svg)](https://wakatime.com/badge/github/abayo-luc/generate-node-project)\n\n# generate-node-project\n\nGenerate a complete NodeJS app (API) with babel, jest, Sequelize, JWT already configured for you.\n\n- [Creating an App](#creating-an-app) – How to create a new app.\n\nGenerate Node Project works on macOS, Windows, and Linux.\u003cbr\u003e\nIf something doesn’t work, please [file an issue](https://github.com/abayo-luc/generate-node-project/issues/new).\u003cbr\u003e\nIf you have questions or need help, please ask via email: luc.bayo@gmail.com\n\n## Installation\n\n```sh\nnpm i -g generate-node-project\n```\n\nor\n\n```sh\nyarn global add generate-node-project\n```\n\n## Quick Overview\n\n```sh\ngenerate-node-project new_node\ncd new_node\nnpm start\n```\n\n### Get Started Immediately\n\nYou **don’t** need to install or configure tools like babel, eslint, sequelize, jest, mocha, mongodb, etc....\u003cbr\u003e\nThey are pre-configured and working, so that you can focus on the code.\n\nCreate a project, and you’re good to go.\n\n## Creating an App\n\n**You’ll need to have Node 8.16.0 or Node 10.16.0 or later version on your local development machine**\n\nTo create a new app, you may choose one of the following methods:\n\n### generate-node-project\n\n```sh\ngenerate-node-project new_node\n```\n\n### OR create-node-api\n\n```sh\ncreate-node-api new_node\n```\n\nIt will create a directory called `new_node` inside the current folder.\u003cbr\u003e\nInside that directory, it will generate the initial project structure and install the required dependencies:\n\n```\nnew_node\n├── README.md\n├── node_modules\n├── package.json\n├── .gitignore\n├── .eslintrc\n├── .jest.config.js\n├── .env\n├── app.js\n├── index.js\n├── __tests__\n└── src\n    ├── config\n    ├── controllers\n    ├── routes\n    ├── models\n    ├── migrations\n    └── seeders\n```\n\nNow all the configurations and folder structures are done for you.\u003cbr\u003e\nOnce the installation is done, you can open your project folder:\n\n```sh\ncd new_node\n```\n\nInside the newly created project, you can run some existing commands:\n\n### `npm start` or `yarn start`\n\nRuns the app in development mode.\u003cbr\u003e\nAnd it will be available on [http://localhost:3000](http://localhost:3000).\n\n### `npm test` or `yarn test`\n\nRuns the test.\u003cbr\u003e\n\n## More Commands:\n\nGenerate basic NodeJs API: javascript\n\n```sh\ngenerate-node-project app_name --skip\n```\n\nGenerate basic NodeJs API: typscript\n\n```sh\ngenerate-node-project app_name --template=typescript\n```\n\nView all available commands\n\n```sh\ngenerate-node-project --help\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fabayo-luc%2Fgenerate-node-project","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fabayo-luc%2Fgenerate-node-project","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fabayo-luc%2Fgenerate-node-project/lists"}