CRUD API

.env

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

.gitignore

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

Readme.md

@@ -0,0 +1,54 @@
+# RS School Node.js CRUD-API  
+___  
+## Launch manual  
+- __Node.js 20 required__
+- `npm install`  
+- To run server: `npm start:dev`
+- Test with Postman   
+- You can also configure PORT in `.env` file
+- To build: `npm run build`  
+- To build and run built prod version: `npm run start:prod`  
+- To run tests: `npm run test`  
+- Also you can try option with `npm run start:multi`. It is launched in dev mode. Starts N workers for clustering (in my case: 16) - and they are listening to requests as well as main port. 
+
+___  
+## API Manual:  
+### `/api/users` or `/api/users/`:  
+- __*GET*__: returns array of all users  
+- __*POST*__: creates new user with __required data__:
+  - `{username: string, age: number, hobbies: string[]}`  
+  - __Important__: all data must be provided. All types must be as mentioned. 
+Validators check it and will not allow to create user for example with hobbies: ['hobby1', 123], because all items in hobbies must be strings
+- Any other method to this endpoint will lead to NOT_FOUND `404` server response
+### `/api/users/<user_id>`: 
+- For example `/api/users/8e4aeab6-0d84-490d-b423-831bc1a2ed23`  
+- __*GET*__: Returns user object with provided ID  
+  - If `<user_id>` is not UUID — then `400` BAD_REQUEST must be returned  
+  - If user not found by id — then `404` NOT_FOUND must be returned
+- __*PUT*__: Updates user. You should provide something like `Partial<User>`. It means that you can send as data to it `{"username": "New Name"}` — and only `username` will be updated. Or you can send `{"username": "New Name", "hobbies": ["New hobby"]}` - so 2 fields will be updated.
+  - __Important__: Fields will be updated only if validation rules are applied.
+  - For example if you send `{"username": 123}` - there will be no update.
+  - Or if you send `{"username": "New Name", age: "NOT AN AGE"}` — only `username` will be updated
+- __*DELETE*__: Deletes user and returns `204` status. If user not found - returns `404`. If provided uuid is not actual UUID - returns `400`
+___    
+### To test multi-server (via cluster and workers):    
+__EXAMPLE FROM ASSIGNMENT:__ _// Also can try using your own. Check out logs in console to see how it works !_
+- On `localhost:4000/api` load balancer is listening for requests
+- On `localhost:4001/api`, `localhost:4002/api`, `localhost:4003/api` workers are listening for requests from load balancer
+- When user sends request to `localhost:4000/api`, load balancer sends this request to `localhost:4001/api`, next user request is sent to `localhost:4002/api` and so on.
+- After sending request to `localhost:4003/api` load balancer starts from the first worker again (sends request to `localhost:4001/api`)
+- State of db should be consistent between different workers, for example:
+  1. First `POST` request addressed to `localhost:4001/api` creates user
+  2. Second `GET` request addressed to `localhost:4002/api` should return created user
+  3. Third `DELETE` request addressed to `localhost:4003/api` deletes created user
+  4. Fourth `GET` request addressed to `localhost:4001/api` should return **404** status code for created user
+___
+### Used:  
+- _**Language**: [TypeScript](https://www.typescriptlang.org/)_  
+- _**Linting and formatting**: [ESLint](https://eslint.org/) with modern flat config and [ESLint.style](https://eslint.style/) for rules & formatting_
+- _**Testing**: [Jest](https://jestjs.io/) and [SuperTest](https://www.npmjs.com/package/supertest) for testing API_
+___  
+
+###### Copyright 2024
+###### Created by [@user-of-github](https://github.com/user-of-github)  
+###### Inspired by Rolling Scopes and RS NodeJS 2024 Q1

eslint.config.js

@@ -0,0 +1,32 @@
+const stylisticJs = require('@stylistic/eslint-plugin-js');
+const stylisticTs = require('@stylistic/eslint-plugin-ts');
+const parserTs = require('@typescript-eslint/parser');
+
+module.exports = [{
+  plugins: {
+    '@stylistic/js': stylisticJs,
+    '@stylistic/ts': stylisticTs
+  },
+  files: [
+    '**/*.js',
+    '**/*.cjs',
+    '**/*.mjs',
+    '**/*.ts',
+    '**/*.tsx'
+  ],
+  languageOptions: {
+    parser: parserTs,
+  },
+  rules: {
+    indent: ['error', 2, {
+      SwitchCase: 1
+    }],
+    quotes: ['error', 'single'],
+    semi: ['error', 'always']
+  },
+
+  ignores: [
+    'build/*',
+    'node_modules/*',
+  ]
+}];

index.html

@@ -0,0 +1,12 @@
+<!DOCTYPE html>
+<html>
+    <head>
+        <meta charset="utf-8" />
+        <title>Webpack App</title>
+    </head>
+    <body>
+        <h1>Hello world!</h1>
+        <h2>Tip: Check your console</h2>
+    </body>
+
+</html>

jest.config.js

@@ -0,0 +1,5 @@
+/** @type {import('ts-jest').JestConfigWithTsJest} */
+module.exports = {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+};