CRUD-API

.env

@@ -0,0 +1 @@
+PORT=4000

.eslintrc.js

@@ -0,0 +1,25 @@
+module.exports = {
+  env: {
+    es2021: true,
+    node: true,
+  },
+  extends: ['eslint:recommended', 'plugin:@typescript-eslint/recommended', 'prettier'],
+  overrides: [
+    {
+      env: {
+        node: true,
+      },
+      files: ['.eslintrc.{js,cjs}'],
+      parserOptions: {
+        sourceType: 'script',
+      },
+    },
+  ],
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    ecmaVersion: 'latest',
+    sourceType: 'module',
+  },
+  plugins: ['@typescript-eslint'],
+  rules: {},
+};

.gitignore

@@ -73,7 +73,7 @@ web_modules/
 .yarn-integrity
 
 # dotenv environment variable files
-.env
+#.env
 .env.development.local
 .env.test.local
 .env.production.local

.prettierrc

@@ -0,0 +1,5 @@
+{
+  "printWidth": 110,
+  "tabWidth": 2,
+  "singleQuote": true
+}

.vscode/settings.json

@@ -0,0 +1,8 @@
+{
+  "editor.formatOnSave": true,
+  "[typescript]": {
+    "editor.codeActionsOnSave": {
+      "source.organizeImports": "explicit"
+    }
+  }
+}

README.md

@@ -1 +1,39 @@
-# CRUD-API
+# CRUD-API
+
+## Description
+
+This is a CRUD (Create, Read, Update, Delete) API project.
+
+## Installation
+
+1. Clone the repository: `git clone <repository-url>`
+2. Install the required dependencies by running `npm install`
+
+## Usage
+
+1. Start the server by running one of the commands:
+
+- Development mode: `npm run start:dev`
+- Production mode: `npm run start:prod`
+- Multi-instance mode: `npm run start:multi`
+
+2. Access the API endpoints using a tool like Postman or cURL.
+
+## API Endpoints
+
+- `GET /api/users`: Retrieve all users.
+- `GET /api/users/:id`: Retrieve a specific user by ID.
+- `POST /api/users`: Create a new user.
+- `PUT /api/users/:id`: Update a specific user by ID.
+- `DELETE /api/users/:id`: Delete a specific user by ID.
+
+## Scripts
+
+- Check code formatting: `npm run prettier:check`
+- Format code: `npm run prettier:write`
+- Run linting: `npm run lint`
+- Run tests: `npm run test`
+
+## Technologies Used
+
+- Node.js

jest.config.ts

@@ -0,0 +1,5 @@
+export default {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+  setupFiles: ['<rootDir>/setupTests.ts'],
+};