chore: first commit

.dockerignore

@@ -0,0 +1,4 @@
+node_modules
+.git
+**/__mocks__
+**/*.test.ts

.eslintrc

@@ -0,0 +1,17 @@
+{
+  "root": true,
+  "env": {
+    "node": true,
+    "browser": true
+  },
+  "extends": [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/recommended",
+    "prettier"
+  ],
+  "parser": "@typescript-eslint/parser",
+  "plugins": ["@typescript-eslint", "prettier"],
+  "rules": {
+    "prettier/prettier": "error"
+  }
+}

.github/workflows/lint.yml

@@ -0,0 +1,17 @@
+name: Linting
+on: [pull_request]
+
+jobs:
+  lint:
+    if: "!contains(github.event.pull_request.title, 'WIP!')"
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Use Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: '18.x'
+      - name: Install Dependencies
+        run: npm ci
+      - name: Run Eslint
+        run: npm run lint

.github/workflows/pretty.yml

@@ -0,0 +1,17 @@
+name: Prettier
+on: [pull_request]
+
+jobs:
+  pretty:
+    if: "!contains(github.event.pull_request.title, 'WIP!')"
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Use Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: '18.x'
+      - name: Install Dependencies
+        run: npm ci
+      - name: Run Prettier
+        run: npm run pretty

.github/workflows/typescript.yml

@@ -0,0 +1,17 @@
+name: Type Check
+on: [pull_request]
+
+jobs:
+  ts:
+    if: "!contains(github.event.pull_request.title, 'WIP!')"
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Use Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: '18.x'
+      - name: Install Dependencies
+        run: npm ci
+      - name: Run Type Check
+        run: npm run typecheck

.github/workflows/unittests.yml

@@ -0,0 +1,16 @@
+name: Unit Tests
+on: [push]
+
+jobs:
+  unittests:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Use Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: '18.x'
+      - name: Install Dependencies
+        run: npm ci
+      - name: Run Unit Tests
+        run: npm test

.gitignore

@@ -0,0 +1,2 @@
+node_modules/
+.DS_Store

.husky/commit-msg

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npx --no -- commitlint --edit

.prettierrc

@@ -0,0 +1,6 @@
+{
+  "useTabs": false,
+  "tabWidth": 2,
+  "singleQuote": true,
+  "trailingComma": "none"
+}

CONTRIBUTING.md

@@ -0,0 +1,62 @@
+# Submitting Issues
+
+We use GitHub issues to track public bugs. If you are submitting a bug, please provide
+as much info as possible to make it easier to reproduce the issue and update unit tests.
+
+# Contributing Code
+
+This project uses [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/#summary).
+
+We follow the [GitHub Flow](https://guides.github.com/introduction/flow/index.html) so all contributions happen through pull requests. We actively welcome your pull requests:
+
+1.  Fork the repo and create your branch from master.
+2.  If you've added code that should be tested, add tests.
+3.  If you've changed APIs, update the documentation.
+4.  Ensure the test suite passes.
+5.  Issue that pull request!
+
+When submitting code changes your submissions are understood to be under the same MIT License that covers the project. Feel free to contact Eyevinn Technology if that's a concern.
+
+# Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+- The use of sexualized language or imagery and unwelcome sexual attention or advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the Contributor Covenant, version 1.4, available at http://contributor-covenant.org/version/1/4

Dockerfile

@@ -0,0 +1,15 @@
+ARG NODE_IMAGE=node:18-alpine
+
+FROM ${NODE_IMAGE}
+ENV NODE_ENV=production
+EXPOSE 8000
+RUN mkdir /app
+RUN chown node:node /app
+USER node
+WORKDIR /app
+COPY --chown=node:node ["package.json", "package-lock.json*", "tsconfig*.json", "./"]
+COPY --chown=node:node ["src", "./src"]
+# Delete prepare script to avoid errors from husky
+RUN npm pkg delete scripts.prepare \
+    && npm ci --omit=dev
+CMD [ "npm", "run", "start" ]

LICENSE

@@ -0,0 +1,8 @@
+The MIT License (MIT)
+Copyright (c) 2023 Eyevinn Technology AB
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

commitlint.config.js

@@ -0,0 +1 @@
+module.exports = { extends: ['@commitlint/config-conventional'] };

jest.config.js

@@ -0,0 +1,4 @@
+module.exports = {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+};

nodemon.json

@@ -0,0 +1,5 @@
+{
+  "watch": ["src"],
+  "ext": "ts",
+  "exec": "node --inspect -r ts-node/register ./src/server.ts"
+}

package.json

@@ -0,0 +1,44 @@
+{
+  "name": "@eyevinn/typescript-nodejs",
+  "version": "1.0.0",
+  "description": "The default typescript-nodejs template for eyevinn projects",
+  "scripts": {
+    "test": "jest",
+    "prepare": "husky install",
+    "lint": "eslint .",
+    "pretty": "prettier --check --ignore-unknown .",
+    "typecheck": "tsc --noEmit -p tsconfig.json",
+    "dev": "nodemon",
+    "start": "ts-node -T src/server.ts"
+  },
+  "license": "MIT",
+  "engines": {
+    "node": ">=18.15.0"
+  },
+  "dependencies": {
+    "@fastify/cors": "^8.2.0",
+    "@fastify/swagger": "^8.3.1",
+    "@fastify/swagger-ui": "^1.5.0",
+    "@fastify/type-provider-typebox": "^3.6.0",
+    "@sinclair/typebox": "^0.29.0",
+    "fastify": "4.23.2",
+    "nodemon": "^2.0.20",
+    "ts-node": "^10.9.1"
+  },
+  "devDependencies": {
+    "@commitlint/cli": "^17.4.2",
+    "@commitlint/config-conventional": "^17.4.2",
+    "@types/jest": "^29.4.0",
+    "@types/node": "^18.11.18",
+    "@typescript-eslint/eslint-plugin": "^5.51.0",
+    "@typescript-eslint/parser": "^5.51.0",
+    "eslint": "^8.33.0",
+    "eslint-config-prettier": "^8.6.0",
+    "eslint-plugin-prettier": "^4.2.1",
+    "husky": "^8.0.3",
+    "jest": "^29.5.0",
+    "prettier": "^2.8.4",
+    "ts-jest": "^29.0.5",
+    "typescript": "^4.9.5"
+  }
+}

readme-typescript-nodejs.md

@@ -0,0 +1,17 @@
+# typescript-nodejs 
+
+Requirements: node.js >= 18.15.0 ( LTS )
+
+Template for TypeScript nodejs projects. It includes:
+
+- nodemon for development including reloading on file changes.
+- ts-node runtime for both development and production.
+- basic fastify setup
+- schema & types using typebox
+- jest for unit-testing
+
+## Getting started
+
+1. Update package.json with your project details
+2. Install dependencies with `npm install`
+3. Start coding!

readme.md

@@ -0,0 +1,62 @@
+<h1 align="center">
+  Project Name or Logo
+</h1>
+
+<div align="center">
+  project name - quick salespitch why this is awesome. 
+  <br />
+  <br />
+  :book: <b><a href="https://eyevinn.github.io/{{repo-name}}/">Read the documentation (github pages)</a></b> :eyes:
+  <br />
+</div>
+
+<div align="center">
+<br />
+
+[![npm](https://img.shields.io/npm/v/@eyevinn/{{repo-name}}?style=flat-square)](https://www.npmjs.com/package/@eyevinn/{{repo-name}})
+[![github release](https://img.shields.io/github/v/release/Eyevinn/{{repo-name}}?style=flat-square)](https://github.com/Eyevinn/{{repo-name}}/releases)
+[![license](https://img.shields.io/github/license/eyevinn/{{repo-name}}.svg?style=flat-square)](LICENSE)
+
+[![PRs welcome](https://img.shields.io/badge/PRs-welcome-ff69b4.svg?style=flat-square)](https://github.com/eyevinn/{{repo-name}}/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22)
+[![made with hearth by Eyevinn](https://img.shields.io/badge/made%20with%20%E2%99%A5%20by-Eyevinn-59cbe8.svg?style=flat-square)](https://github.com/eyevinn)
+[![Slack](http://slack.streamingtech.se/badge.svg)](http://slack.streamingtech.se)
+
+</div>
+
+<!-- Add a description of the project here -->
+
+## Requirements
+
+<!--Add any external project dependencies such as node.js version etc here -->
+
+## Installation / Usage
+
+<!--Add clear instructions on how to use the project here -->
+
+## Development
+
+<!--Add clear instructions on how to start development of the project here -->
+
+## Contributing
+
+See [CONTRIBUTING](CONTRIBUTING.md)
+
+## License
+
+This project is licensed under the MIT License, see [LICENSE](LICENSE).
+
+# Support
+
+Join our [community on Slack](http://slack.streamingtech.se) where you can post any questions regarding any of our open source projects. Eyevinn's consulting business can also offer you:
+
+- Further development of this component
+- Customization and integration of this component into your platform
+- Support and maintenance agreement
+
+Contact [[email protected]](mailto:[email protected]) if you are interested.
+
+# About Eyevinn Technology
+
+[Eyevinn Technology](https://www.eyevinntechnology.se) is an independent consultant firm specialized in video and streaming. Independent in a way that we are not commercially tied to any platform or technology vendor. As our way to innovate and push the industry forward we develop proof-of-concepts and tools. The things we learn and the code we write we share with the industry in [blogs](https://dev.to/video) and by open sourcing the code we have written.
+
+Want to know more about Eyevinn and how it is to work here. Contact us at [email protected]!

src/api.test.ts

@@ -0,0 +1,13 @@
+import api from './api';
+
+describe('api', () => {
+  it('responds with hello, world!', async () => {
+    const server = api({ title: 'my awesome service' });
+    const response = await server.inject({
+      method: 'GET',
+      url: '/'
+    });
+    expect(response.statusCode).toBe(200);
+    expect(response.body).toBe('Hello, world! I am my awesome service');
+  });
+});