{"id":14967594,"url":"https://github.com/bryopsida/express-pug-bootstrap-starter-template","last_synced_at":"2025-08-25T06:36:54.396Z","repository":{"id":209040180,"uuid":"723022536","full_name":"bryopsida/express-pug-bootstrap-starter-template","owner":"bryopsida","description":"A starter template for an app using express, pug, and bootstrap, mostly an experiment in simplicity for a full stack app.","archived":false,"fork":false,"pushed_at":"2024-10-26T00:36:09.000Z","size":925,"stargazers_count":1,"open_issues_count":4,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-10-30T02:28:24.700Z","etag":null,"topics":["bootstrap","bootstrap5","express","nodejs","pug-template-engine","pugjs","starter-template"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bryopsida.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2023-11-24T13:48:39.000Z","updated_at":"2024-10-26T00:36:12.000Z","dependencies_parsed_at":"2024-01-20T04:26:23.967Z","dependency_job_id":"95f03a4e-9f95-4d24-b30b-9de1c382738e","html_url":"https://github.com/bryopsida/express-pug-bootstrap-starter-template","commit_stats":{"total_commits":152,"total_committers":3,"mean_commits":"50.666666666666664","dds":"0.26973684210526316","last_synced_commit":"4ad4fe3eb668531ab18695c5f396b235ba3e2e1d"},"previous_names":["bryopsida/express-pug-bootstrap-starter-template"],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bryopsida%2Fexpress-pug-bootstrap-starter-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bryopsida%2Fexpress-pug-bootstrap-starter-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bryopsida%2Fexpress-pug-bootstrap-starter-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bryopsida%2Fexpress-pug-bootstrap-starter-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bryopsida","download_url":"https://codeload.github.com/bryopsida/express-pug-bootstrap-starter-template/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238207646,"owners_count":19434095,"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":["bootstrap","bootstrap5","express","nodejs","pug-template-engine","pugjs","starter-template"],"created_at":"2024-09-24T13:38:19.847Z","updated_at":"2025-02-10T23:31:31.175Z","avatar_url":"https://github.com/bryopsida.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# What is this?\n\nThis is a basic starter template for a web app. It's intended use case is for simple things that do not warrant using a SPA or other heavier client side frameworks. It opts for a very simple dev loop, no building/compiling, simply edit the files and the changes are live.\n\n## Pre-Requisites\n\n- Node.JS \u003e= 20\n\n## Getting Started\n\nTo launch the app, install the dependencies `npm install`, and then run `npm start`, and navigate [here](http://localhost:3000/), to login check the `./logs/audit.log` for the generated admin password, you can change this afterwards.\n\nIf you wish to make a change, follow the above directions, expect instead of running `npm start`, run `npm run dev`. On save of your JavaScript files the server will automatically reload with the new changes.\n\n## What opinions have been added\n\n1. [Express](https://www.npmjs.com/package/express) - this is used for the application server\n2. [Helmet](https://www.npmjs.com/package/helmet) - when NODE_ENV is set to production helmet is used\n3. [Nodemon](https://www.npmjs.com/package/nodemon) - used for automatically reloading when JavaScript files are changed\n4. [Casl](https://www.npmjs.com/package/@casl/ability) - used for authorization rules\n5. [Pug](https://www.npmjs.com/package/pug) - used for server side rending of pages\n6. [Jest](https://www.npmjs.com/package/jest) - used for unit tests\n7. [Playwright](https://www.npmjs.com/package/playwright) - used for e2e tests\n8. [Iron-session](https://www.npmjs.com/package/iron-session) - used for stateless auth using cookies\n9. [Bootstrap](https://www.npmjs.com/package/bootstrap) - used for client styling and components\n10. [Standard.JS](https://www.npmjs.com/package/standard) - linting rules\n11. [Prettier](https://www.npmjs.com/package/prettier) - for formatting files\n12. [Config](https://www.npmjs.com/package/config) - for providing configuration system\n13. [Sequelize](https://www.npmjs.com/package/sequelize) - ORM\n14. [Sqlite3](https://www.npmjs.com/package/sqlite3) - Embedded database\n15. [Umzug](https://www.npmjs.com/package/umzug) - Migration and seed runner\n\n## NPM Scripts\n\n| Script   | Description                                                          |\n| -------- | -------------------------------------------------------------------- |\n| dev      | Uses nodemon to automatically restart server when javascript changes |\n| test     | Runs unit tests using Jest                                           |\n| test:e2e | Runs e2e tests using Playwright                                      |\n| lint     | Checks code/files using Standard.JS and Prettier                     |\n| lint:fix | Automatically fix style and linting violations                       |\n| start    | Runs the application server                                          |\n\n## Environment Variables\n\n| Name            | Default | Description                                |\n| --------------- | ------- | ------------------------------------------ |\n| PORT            | 3000    | The Listening port of the server           |\n| COOKIE_PASSWORD |         | The 32 byte key used to encrypt the cookie |\n\n## Structure\n\n- `services/` - services that support pages, routes and other activities of the server\n- `routes/` - express route controllers\n- `public/` - static files served by the web server\n- `middleware/` - middleware functions that can be applied to many routes\n- `config/` - config files and environment variable mapping\n- `tests/` - E2E Tests\n- `views/` - PUG templates\n- `db/` - Database models, migrations and seeds\n\n## Managing DB Models and Migrations\n\n### Create a new model\n\nYou can create a new model/table by running `npx sequelize-cli model:generate --name TableName --attributes prop1:string,prop2:string`, this will create a basic migration for you under `./db/migrations` and a new model under `./db/models`.\n\n### Create a new migration\n\nYou can create a new migration by running `npx sequelize-cli migration:create --name your-migration-name`\n\n### Create a new seed\n\nYou can create a new seed by running `npx sequelize-cli seed:generate --name seed-name`\n\n### Manually running migrations\n\nYou can manually run migrations by running `npx sequelize-cli db:migrate`\n\n## Post template checklist\n\n- [ ] Change footer copyright to match your needs\n- [ ] Change header to add logo/branding to match your needs\n- [ ] Change global.css to match your styling needs\n- [ ] Change/remove renovate.json to match your needs\n- [ ] Update package name in package.json to your project name\n- [ ] Update `services/users.js` to use your user store\n- [ ] Update COOKIE_PASSWORD for production instances\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbryopsida%2Fexpress-pug-bootstrap-starter-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbryopsida%2Fexpress-pug-bootstrap-starter-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbryopsida%2Fexpress-pug-bootstrap-starter-template/lists"}