{"id":22062709,"url":"https://github.com/ryan-haskell/kickshark","last_synced_at":"2026-04-16T05:02:34.076Z","repository":{"id":88811495,"uuid":"126285367","full_name":"ryan-haskell/kickshark","owner":"ryan-haskell","description":"Create frontend templates with Express and Pug.","archived":false,"fork":false,"pushed_at":"2018-03-22T05:43:41.000Z","size":13,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-19T17:48:59.542Z","etag":null,"topics":["express","pug","templating"],"latest_commit_sha":null,"homepage":null,"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/ryan-haskell.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}},"created_at":"2018-03-22T05:41:25.000Z","updated_at":"2018-06-22T19:05:28.000Z","dependencies_parsed_at":"2023-06-12T18:45:43.650Z","dependency_job_id":null,"html_url":"https://github.com/ryan-haskell/kickshark","commit_stats":null,"previous_names":["ryan-haskell/kickshark"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ryan-haskell%2Fkickshark","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ryan-haskell%2Fkickshark/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ryan-haskell%2Fkickshark/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ryan-haskell%2Fkickshark/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ryan-haskell","download_url":"https://codeload.github.com/ryan-haskell/kickshark/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245144021,"owners_count":20568049,"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":["express","pug","templating"],"created_at":"2024-11-30T18:26:36.998Z","updated_at":"2026-04-16T05:02:34.007Z","avatar_url":"https://github.com/ryan-haskell.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Kickshark\n\u003e Create frontend templates with Express and Pug.\n\n\n### Try it out\n\n1. Install `kickshark` as a dependency:\n\n```\nnpm install -S kickshark\n```\n\n2. Create an `app.js` in your project:\n\n```js\nconst kickshark = require('kickshark')\n\nkickshark.start({\n  name: 'Your Project',\n  dir: __dirname\n})\n```\n\n3. Run `node app.js` and check out `http://localhost:3000`\n\n---\n\n### Project Overview\n\u003e Check out a full example in the [`example/`](https://github.com/ryannhg/kickshark/tree/master/example) folder!\n\nTo get up and running, just create the following folder structure:\n\nFolder | Description\n--- | ---\n`api/` | All API endpoints, with auto-generated routes.\n`layouts/` | Where to put any layout files.\n`mixins/` | Where to put any pug mixins.\n`pages/` | All your pages.\n`public/` | Static content for `/public` requests.\n\nFor `api/` and `pages/`, we use the [NuxtJS route naming convention](https://nuxtjs.org/guide/routing) to __automatically generate__ your express routes.\n\nIf you follow this convention, your pages and API endpoints will already be hooked up for you!\n\n---\n\n### Documentation\n\n#### `kickshark.start(config)`\n\n__Parameters__\n\n- `config.dir` - The root directory of your project (Default: `__dirname`)\n\n- `config.name` - Display name (Default: `\"Kickshark\"`)\n\n- `config.port` - Port to run the server on (Default: `process.env.PORT || 3000`)\n\n- `config.pug` - [Options](https://pugjs.org/api/reference.html#options) for Pug (Default: `{ basedir: config.dir, pretty: process.env.NODE_ENV !== 'production' }`)\n\n__Example__\n\n```js\nconst kickshark = require('kickshark')\n\nkickshark.start({\n  dir: __dirname,\n  name: 'My Site',\n  port: 5000\n})\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fryan-haskell%2Fkickshark","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fryan-haskell%2Fkickshark","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fryan-haskell%2Fkickshark/lists"}