feat: add readme and github actions

Author: ismanapa

.github/workflows/lint.yml

@@ -0,0 +1,28 @@
+name: lint
+
+on: push
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Cache node modules
+        uses: actions/cache@v2
+        env:
+          cache-name: cache-node-modules
+        with:
+          path: ~/.npm
+          key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-build-${{ env.cache-name }}-
+            ${{ runner.os }}-build-
+            ${{ runner.os }}-
+            
+      - name: Install Dependencies
+        run: npm install
+
+      - name: Lint
+        run: npm run lint

.github/workflows/test.yml

@@ -0,0 +1,28 @@
+name: test
+
+on: push
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Cache node modules
+        uses: actions/cache@v2
+        env:
+          cache-name: cache-node-modules
+        with:
+          path: ~/.npm
+          key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-build-${{ env.cache-name }}-
+            ${{ runner.os }}-build-
+            ${{ runner.os }}-
+
+      - name: Install Dependencies
+        run: npm install
+
+      - name: Test
+        run: npm run test

readme.md

@@ -0,0 +1,48 @@
+# TypeScript Express API Bootstrap (base / project starter)
+
+This is a repository intended to serve as a starting point if you want to bootstrap a express API project in TypeScript.
+
+## Features
+
+- [TypeScript](https://www.typescriptlang.org/) (v4)
+- [ts-node-dev](https://github.com/wclr/ts-node-dev)
+- [Prettier](https://prettier.io/)
+- [ESLint](https://eslint.org/) with:
+  - [Simple Import Sort](https://github.com/lydell/eslint-plugin-simple-import-sort/)
+  - [Import plugin](https://github.com/benmosher/eslint-plugin-import/)
+- [Jest](https://jestjs.io) with [DOM Testing Library](https://testing-library.com/docs/dom-testing-library/intro)
+- [GitHub Action workflows](https://github.com/features/actions) set up to run tests and linting on push
+
+## Running the app
+
+```
+# install dependencies
+npm install
+
+# run in dev mode on port 3000
+npm run dev
+
+# generate production build
+npm run build
+
+# run generated content in dist folder on port 3000
+npm run start
+```
+
+## Testing
+
+### Jest with supertest
+
+```
+npm run test
+```
+
+## Linting
+
+```
+# run linter
+npm run lint
+
+# fix lint issues
+npm run lint:fix
+```