{"id":19702907,"url":"https://github.com/kishcom/scaffnode","last_synced_at":"2025-04-29T14:30:35.527Z","repository":{"id":2059412,"uuid":"2997697","full_name":"KishCom/scaffnode","owner":"KishCom","description":"My personally preferred node.js webapp scaffold: Node.js + ExpressJS + Nunjucks Templates + SASS + Mocha/Chai/Karma + Svelte based frontend","archived":false,"fork":false,"pushed_at":"2025-03-27T16:18:46.000Z","size":3878,"stargazers_count":11,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-26T15:12:01.226Z","etag":null,"topics":["boilerplate","javascript","nodejs","svelte","template","webpack"],"latest_commit_sha":null,"homepage":"https://github.com/KishCom/scaffnode","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/KishCom.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":"2011-12-16T21:07:24.000Z","updated_at":"2025-03-27T16:13:42.000Z","dependencies_parsed_at":"2024-09-17T23:09:13.047Z","dependency_job_id":null,"html_url":"https://github.com/KishCom/scaffnode","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/KishCom%2Fscaffnode","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KishCom%2Fscaffnode/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KishCom%2Fscaffnode/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KishCom%2Fscaffnode/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/KishCom","download_url":"https://codeload.github.com/KishCom/scaffnode/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251518725,"owners_count":21602202,"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":["boilerplate","javascript","nodejs","svelte","template","webpack"],"created_at":"2024-11-11T21:16:25.005Z","updated_at":"2025-04-29T14:30:34.059Z","avatar_url":"https://github.com/KishCom.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"    ____ ____ ____ ____ ____ _  _ ____ ___  ____\n    [__  |    |__| |___ |___ |\\ | |  | |  \\ |___\n    ___] |___ |  | |    |    | \\| |__| |__/ |___\n\nAn ever changing personal preference Node.js web-app scaffolding.\n\nUse this if you're looking to hit the ground running with a project using Node.js, and popular Node.js modules (Express.js, Bunyan logs, Multer file uploads, Nunjucks HTML templates).\n\nTo install, make sure you have Node.js (\u003e16.x) installed on your system as well as NPM. Make sure your node_modules folder, or the NODE_PATH environment variable are setup properly as well. Tested on Linux and OSX only. Windows users will need to address the `NODE_ENV` environment variable.\n\nIf your Node.js and NPM are already configured, setup and installation is a breeze:\n\n    # Install nodemon and bunyan globally\n    npm install bunyan nodemon mocha webpack webpack-cli -g\n    # Get other dependencies\n    npm install\n    # Configure server environment details\n    cp config.sample.js config.js\n\n    # Name the project. Replace \"YourProjectsNameHere\" in the next command with your project name (alpha-numeric only)\n    find . -type f | xargs sed -i 's/scaffnode/YourProjectsNameHere/gi'\n\n    # Edit config.js with your details\n\n    # Then start the server:\n    npm start\n\n## Frontend\n\n(DOCUMENTATION IN PROGRESS) The scaffnode frontend is a Svelte based SPA.\n\n    cd frontend\n    npm i\n    \n    #Build for development\n    npm run build #which runs: NODE_ENV=dev npx webpack --config webpack.config.js\n    \n    ##OR watch for changes and rebuild:\n    npm run watch #which runs: NODE_ENV=dev npx webpack --watch --config webpack.config.js\n\n    ##OR build for production\n    npm run build.live #which runs: NODE_ENV=live npx webpack --config webpack.config.js\n    \n\n## Tests\n\nScaffnode is setup for backend API tests using ([Mocha](http://mochajs.org/) + [superagent](http://visionmedia.github.io/superagent/)) as well as frontend tests using [Jest](https://facebook.github.io/jest/).\n\nRun tests:\n\n    npm test\n\nWhich is just an alias of:\n\n    NODE_ENV=dev mocha tests/*_tests.js\n\n### i18n Multi-language support\n\nExample language files are found in `locale` and example useage can be found in `views/index.html`.\n\n### Build frontend for production\n\nWe need tests, but until then:\n\n    cd frontend\n    npm run build.live\n    cd ..\n\nor run a live server (concats/minifies JS/CSS)\n\n    npm run start.live\n\n## Live Deploy Helpers\n\nFind NGINX config and SystemD service in the `deploy` folder. You can also use pm2 if desired, a very basic pm2 ecosystem file is provided. The systemD file makes a few assumptions about your environment: You have a `www-data` user+group, and that you installed Node.js with [ASDF](https://asdf-vm.com).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkishcom%2Fscaffnode","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkishcom%2Fscaffnode","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkishcom%2Fscaffnode/lists"}