{"id":14978526,"url":"https://github.com/crispengari/initialiseur","last_synced_at":"2026-04-11T17:04:32.530Z","repository":{"id":43390016,"uuid":"396087108","full_name":"CrispenGari/initialiseur","owner":"CrispenGari","description":"Creating boiler plates node applications (express, koa, electron)  easily with almost no-code with initialiseur.","archived":false,"fork":false,"pushed_at":"2023-03-06T08:01:09.000Z","size":871,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-10-30T04:51:36.656Z","etag":null,"topics":["backend","electronjs","express","expressjs","javascript","koajs","node","nodejs","npm","typescript"],"latest_commit_sha":null,"homepage":"","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/CrispenGari.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"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":"2021-08-14T17:59:35.000Z","updated_at":"2022-07-06T22:34:56.000Z","dependencies_parsed_at":"2024-10-15T05:01:20.460Z","dependency_job_id":null,"html_url":"https://github.com/CrispenGari/initialiseur","commit_stats":{"total_commits":65,"total_committers":2,"mean_commits":32.5,"dds":0.01538461538461533,"last_synced_commit":"28610ef71712cf6891f77acaf1117bfeb639e9f6"},"previous_names":["crispengari/nodejs-backend"],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CrispenGari%2Finitialiseur","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CrispenGari%2Finitialiseur/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CrispenGari%2Finitialiseur/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CrispenGari%2Finitialiseur/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CrispenGari","download_url":"https://codeload.github.com/CrispenGari/initialiseur/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241629741,"owners_count":19993708,"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","electronjs","express","expressjs","javascript","koajs","node","nodejs","npm","typescript"],"created_at":"2024-09-24T13:57:51.079Z","updated_at":"2026-03-07T01:34:25.366Z","avatar_url":"https://github.com/CrispenGari.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"## initialiseur\n\nThis is a package that can be installed on your computer to easily initialize `node.js`node applications boiler plates:\n\n\u003cp align=\"center\"\u003e\n\n\u003cimg src=\"https://github.com/CrispenGari/initialiseur/blob/main/images/logo.png\" alt=\"logo\" width=\"50%\"/\u003e\n\u003c/p\u003e\n\nIt initializes the following boiler plate code\n\n```shell\n- express\n- koa\n- electron\n```\n\n### Express Application\n\nThis backend server is an `express` application with `cors` configured that is ready to run on a configured default port `3001` which can be modified in code. This package can initialize boiler plate code for a basic express application for the following languages:\n\n1. javascript\n2. typescript `(default)`\n\nGenerated files for an `express` boiler plate:\n\n```shell\n\nGenerating Basic Files(🌼) and Folders(📁)\n  📁  src\n     📁  routes\n       🌼 index.ts\n     🌼 server.ts\n  🌼 .gitignore\n  🌼 .env\n  🌼 package.json\n  🌼 tsconfig.json\n```\n\n### Koa Application\n\nThis backend server is an `koa` that is ready to run on a configured default port `3001` which can be modified in code. This package can initialize boiler plate code for a basic express application for the following languages:\n\n1. javascript\n2. typescript `(default)`\n\nGenerated files for an `koa` boiler plate:\n\n```shell\nGenerating Basic Files(🌼) and Folders(📁)\n  📁  src\n     📁  routes\n        📁  hello\n           🌼 index.ts\n     🌼 server.ts\n  🌼 .gitignore\n  🌼 .env\n  🌼 package.json\n  🌼 tsconfig.json\n```\n\n### Electron\n\nThis is skeleton electron application that is ready and running. All you have to do it to change the code according to what you want your application to do. The current version `5.0.*` is currently having one language initialization for an electron application which is:\n\n1. `javascript`\n\nGenerated files for an `electron` boiler plate:\n\n```shell\nGenerating Basic Files(🌼) and Folders(📁)\n  📁  src\n     📁  public\n        🌼 index.html\n     📁  scripts\n        🌼 index.js\n        🌼 preload.js\n     📁  styles\n        🌼 index.css\n     🌼 main.js\n  🌼 .gitignore\n  🌼 README.md\n  🌼 LICENSE\n  🌼 .env\n  🌼 package.json\n```\n\n\u003e Note that this package is coming from `@crispengari/node-backend`.\n\n### Getting started\n\nFirst you need to install the node `initialiseur` globally by running the following command:\n\n1. Using `npm`\n\n```shell\nnpm install -g initialiseur\n```\n\n2. Using `yarn`\n\n```\nyarn global add initialiseur\n```\n\n### Usage\n\nTo initialize a new `node` boiler plate application you run the following command:\n\n```\ninitialiseur init \u003cname\u003e\n```\n\n\u003e Note that you can initialize the `node.js` backend project without installing `initialiseur` globally by the use of `npx`:\n\n```shell\nnpx initialiseur init \u003cname\u003e\n```\n\n- `\u003cname\u003e` is optional if note specified `initialiseur` will use the `root` directory of the project as the default package name, which can be altered as well.\n\n### Available commands in `initialiseur`\n\n1. help\n   This shows all available commands of `initialiseur` package\n\n```shell\ninitialiseur -h\n\n# or\ninitialiseur --help\n```\n\n2. version\n   This shows the currently installed version of `initialiseur` package:\n\n```shell\ninitialiseur -v\n# or\ninitialiseur --version\n```\n\n3. init\n\nThis initializes a new `initialiseur` project:\n\n```shell\n\ninitialiseur init \u003cname\u003e\n# Or\ninitialiseur init\n```\n\n### Starting the apps.\n\n**Note:** Starting the server is different if you are using `typescript` or `javascript` and if you are using `electron`, `koa` or `express`.\n\n1. With `JavaScript`:\n\n```shell\n# yarn\nyarn start\n\n# npm\nnpm run start\n```\n\n\u003e The above command start a application for both `electron`, `koa` and `express`. The `electron` application is currently starting with one command which is the `start`.\n\n2. With `TypeScript`:\n\nWith `ts` you have to open two command the one that will `watch` for file changes and the other one that will run the compiled javascript code:\na) `cmd` 1\n\n```shell\n# yarn\nyarn watch\n\n# npm\nnpm run watch\n```\n\nb) `cmd` 2\n\n```shell\n# yarn\nyarn dev\n\n# npm\nnpm run dev\n```\n\nOr you can run a single command which was introduced in version `5.1.*` which is:\n\n```shell\n# yarn\nyarn start:fast\n\n# npm\nnpm run start:fast\n```\n\n\u003e The above commands can only be run when you are either running a typescript application for either `koa` or `express`.\n\n### From `@crispengari/node-backend` to `initialiseur`\n\n`Initialiseur` was initially `@crispengari/node-backend` so you can initialize the `node.js` backend by running executing `@crispengari/node-backend` using `npx`.\n\n### Executing specific versions\n\nYou can be able to execute the specific versions of `@crispengari/node-backend` using the node package executer (npx)\n\n1. Running the node package executer `npx`\n\n```shell\nnpx @crispengari/node-backend@\u003cversion\u003e\n\n# example (make sure the version exists before running this)\nnpx @crispengari/node-backend@\u003c1.3.2\u003e\n```\n\n### Available working versions\n\n### `v1`\n\n1. `@crispengari/node-backend@1.3.2`\n2. `@crispengari/node-backend@1.3.6`\n3. `@crispengari/node-backend@1.3.7`\n4. `@crispengari/node-backend@1.3.8`\n\n### `v2`\n\n1. `@crispengari/node-backend@2.0.1`\n\n### `v3`\n\n1. `initialiseur@3.0.0`\n2. `initialiseur@3.0.1`\n3. `initialiseur@3.0.2`\n\n### What's new in `initialiseur@4.*.*`?\n\n- In this version developers are allowed to choose licenses templates from the available ones during backend initialization.\n- Developers can also select which additional optional files they want to add in their project during initialization.\n\n### What is new in `initialiseur@5.*.*`?\n\n- In this version developers are now able to select the application they want to initialize between:\n  - express application\n  - electron application\n  - koa application\n- Developers still have choice to choose the programming language to be used among:\n  - javascript\n  - typescript\n\n* The language choices are currently working for the following applcations:\n  - koa application\n  - express application\n\n### Why `initialiseur`?\n\n`initialiseur` is a name that I got from google translation english to french for the name `initializer`. I created this package so that developers can create their backend applications with typescript or javascript without running into a headache of creating files and installing basic packages like `express`.\n\n### Commonly Known Issues.\n\n- The `initialiseur` package has commonly known issue when for starting the `kao` or `express` server for the **first** time with the `start:fast` command for both `npm` and `yarn`. The error is as follows:\n\n```shell\n Error: Cannot find module './server.js'\n```\n\n\u003e The solution to this is to either open one of your `ts` boiler plate files and save it or you stop the command and run it again.\n\n### License\n\n```\nMIT License\n\nCopyright (c) 2021 Crispen Gari\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcrispengari%2Finitialiseur","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcrispengari%2Finitialiseur","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcrispengari%2Finitialiseur/lists"}