1.0.0

Author: aquie00tt

.env.sample

@@ -0,0 +1,22 @@
+# Express & TypeScript Starter Kit Configuration
+
+# The port on which the server will listen for incoming requests.
+# Default value is set to 8080.
+PORT=8080
+
+# A comma-separated list of allowed origins for Cross-Origin Resource Sharing (CORS).
+# This specifies which domains are permitted to access the API.
+ALLOW_LIST=http://localhost:3000,http://localhost:3001
+
+# The version of the API.
+# This should be incremented when breaking changes are made to the API.
+API_VERSION=1
+
+# MongoDB connection string.
+# This specifies the URI to connect to the MongoDB server.
+# Ensure to include the correct database name in the connection string.
+MONGO_CONNECTION_URI=mongodb://localhost:27017/
+
+# The name of the MongoDB database to use.
+# Change this to your desired database name.
+MONGO_DATABASE_NAME=test-db

.github/workflows/ci.yml

@@ -0,0 +1,52 @@
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    services:
+      mongodb:
+        image: mongo:latest
+        ports:
+          - 27017:27017
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: "22"
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Run tests
+        env:
+          NODE_ENV: test
+          PORT: 8080
+          ALLOW_LIST: http://localhost:3000
+          API_VERSION: 1
+          MONGO_CONNECTION_URI: mongodb://localhost:27017/
+          MONGO_DATABASE_NAME: test-db
+        run: npm test
+
+  build:
+    runs-on: ubuntu-latest
+    needs: test
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: "22"
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Build project
+        run: npm run build

.gitignore

@@ -0,0 +1,13 @@
+# Node Modules Directory
+node_modules
+
+# Build
+dist
+
+# Environment Files
+.env.development
+.env.test
+.env.production
+
+# Mac OS
+.DS_STORE

.husky/pre-commit

@@ -0,0 +1 @@
+npx lint-staged

.prettierignore

@@ -0,0 +1,2 @@
+# Ignore artifacts:
+dist

.prettierrc

@@ -0,0 +1,6 @@
+{
+    "semi": true,
+    "singleQuote": false,
+    "useTabs": true,
+    "printWidth": 60
+}

.vscode/launch.json

@@ -0,0 +1,32 @@
+{
+	"version": "0.2.0",
+	"configurations": [
+		{
+			"name": "Run in Development Mode",
+			"type": "node",
+			"request": "launch",
+			"runtimeExecutable": "npm",
+			"runtimeArgs": ["run", "dev"],
+			"console": "integratedTerminal",
+			"internalConsoleOptions": "neverOpen",
+			"skipFiles": [
+				"<node_internals>/**",
+				"${workspaceFolder}/node_modules/**"
+			]
+		},
+		{
+			"name": "Run in Production Mode",
+			"type": "node",
+			"request": "launch",
+			"runtimeExecutable": "npm",
+			"runtimeArgs": ["run", "start"],
+			"console": "integratedTerminal",
+			"internalConsoleOptions": "neverOpen",
+			"skipFiles": [
+				"<node_internals>/**",
+				"${workspaceFolder}/node_modules/**"
+			],
+			"preLaunchTask": "npm: build"
+		}
+	]
+}

.vscode/settings.json

@@ -0,0 +1,8 @@
+{
+	"editor.formatOnSave": true,
+	"editor.defaultFormatter": "esbenp.prettier-vscode",
+	"prettier.requireConfig": true,
+	"editor.wordWrap": "off",
+	"editor.fontSize": 18,
+	"editor.fontFamily": "Cascadia Code"
+}

.vscode/tasks.json

@@ -0,0 +1,13 @@
+{
+	"version": "2.0.0",
+	"tasks": [
+		{
+			"type": "npm",
+			"script": "build",
+			"group": "build",
+			"problemMatcher": [],
+			"label": "npm: build",
+			"detail": "Build the project"
+		}
+	]
+}

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 aquie00tt
+
+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.