feat: resolver for items

.env.dist

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

.eslintrc.js

@@ -0,0 +1,74 @@
+module.exports = {
+  'env': {
+    'es2021': true,
+    'jest': true,
+    'node': true
+  },
+  'plugins': [
+    '@typescript-eslint',
+    'unused-imports',
+    'security',
+    'promise'
+  ],
+  'extends': [
+    'eslint:recommended',
+    'plugin:@typescript-eslint/recommended',
+    'plugin:eslint-comments/recommended',
+    'plugin:import/errors',
+    'plugin:import/warnings',
+    'plugin:security/recommended',
+    'plugin:promise/recommended'
+  ],
+  overrides: [
+    {
+      files: [
+        '**/__tests__/*.{j,t}s?(x)',
+        '**/tests/unit/**/*.spec.{j,t}s?(x)'
+      ],
+      env: {
+        jest: true
+      }
+    }
+  ],
+  'parser': '@typescript-eslint/parser',
+  'rules': {
+    'eqeqeq': ['error', 'smart'],
+    'keyword-spacing': 'error',
+    'comma-spacing': 'error',
+    'arrow-spacing': 'error',
+    'newline-before-return': 'error',
+    'no-multiple-empty-lines': ['error', { 'max': 1, 'maxEOF': 1, 'maxBOF': 0 }],
+    'space-in-parens': ['error', 'never'],
+    'indent': ['error', 2, { 'SwitchCase': 1, 'ignoredNodes': ['JSXElement'] }],
+    'no-multi-spaces': 'error',
+    'no-trailing-spaces': 'error',
+    'brace-style': ['error'],
+    'no-return-await': 'error',
+    'curly': ['error', 'multi-line'],
+    'space-infix-ops': 'error',
+    'quotes': ['error', 'single'],
+    'no-restricted-globals': 'error',
+    'yoda': 'error',
+    'key-spacing': [2, { beforeColon: false, afterColon: true }],
+    'object-curly-spacing': ['error', 'always'],
+    'object-shorthand': ['error', 'always'],
+    'semi': ['error', 'never'],
+    'comma-dangle': ['error', 'never'],
+    'array-bracket-spacing': ['error', 'never'],
+    'no-extra-parens': ['error', 'all', { 'nestedBinaryExpressions': false }],
+    'no-mixed-operators': 'error',
+    'import/no-unresolved': 0,
+    'import/no-anonymous-default-export': 'error',
+    'import/named': 0,
+    'import/namespace': 0,
+    'import/default': 'error',
+    'import/export': 'error',
+    'import/order': 'error',
+    'import/newline-after-import': ['error', { 'count': 1 }],
+    'unused-imports/no-unused-imports': 'error',
+    'unused-imports/no-unused-imports-ts': 'error',
+    '@typescript-eslint/explicit-module-boundary-types': ['error'],
+    '@typescript-eslint/no-unused-vars': 'error',
+    '@typescript-eslint/no-useless-constructor': 'error'
+  }
+}

.gitignore

@@ -0,0 +1 @@
+.env

README.md

@@ -0,0 +1,54 @@
+# Gitclicker API
+
+## Requirements
+
+- `node >= v15.11.0` (Might work for lower version but not tested)
+
+## Install
+
+```bash
+cp .env.dist .env
+yarn install
+```
+
+## Run dev
+
+```bash
+yarn dev
+```
+
+## Enpoints
+
+### `GET /api/shop/items`
+
+Response:
+
+```json
+[
+  {
+    "name": "Bash",
+    "price": 10,
+    "multiplier": 0.1
+  },
+  {
+    "name": "Git",
+    "price": 100,
+    "multiplier": 1.2
+  },
+  {
+    "name": "Javascript",
+    "price": 10000,
+    "multiplier": 14
+  },
+  {
+    "name": "React",
+    "price": 50000,
+    "multiplier": 75
+  },
+  {
+    "name": "Vim",
+    "price": 1000000,
+    "multiplier": 10000
+  }
+]
+```

package.json

@@ -2,5 +2,33 @@
   "name": "react-gitclicker-api",
   "version": "1.0.0",
   "main": "index.js",
-  "license": "MIT"
+  "author": "Antoine Lelaisant <[email protected]>",
+  "license": "MIT",
+  "scripts": {
+    "dev": "ts-node-dev --respawn --pretty --transpile-only src/index.ts",
+    "eslint": "eslint . --ext .ts"
+  },
+  "dependencies": {
+    "cors": "^2.8.5",
+    "dotenv": "^8.2.0",
+    "express": "^4.17.1",
+    "helmet": "^4.4.1"
+  },
+  "devDependencies": {
+    "@types/cors": "^2.8.10",
+    "@types/dotenv": "^8.2.0",
+    "@types/express": "^4.17.11",
+    "@types/helmet": "^4.0.0",
+    "@types/node": "^14.14.34",
+    "@typescript-eslint/eslint-plugin": "^4.17.0",
+    "@typescript-eslint/parser": "^4.17.0",
+    "eslint": "^7.22.0",
+    "eslint-plugin-eslint-comments": "^3.2.0",
+    "eslint-plugin-import": "^2.22.1",
+    "eslint-plugin-promise": "^4.3.1",
+    "eslint-plugin-security": "^1.4.0",
+    "eslint-plugin-unused-imports": "^1.1.0",
+    "ts-node-dev": "^1.1.6",
+    "typescript": "^4.2.3"
+  }
 }

src/index.ts

@@ -0,0 +1,25 @@
+import * as dotenv from 'dotenv'
+import express from 'express'
+import cors from 'cors'
+import helmet from 'helmet'
+import { itemsRouter } from './items/items.router'
+
+dotenv.config()
+
+if (!process.env.PORT) {
+  process.exit(1)
+}
+
+const PORT: number = parseInt(process.env.PORT as string, 10)
+
+const app = express()
+
+app.use(helmet())
+app.use(cors())
+app.use(express.json())
+
+app.use('/api/shop/items', itemsRouter)
+
+app.listen(PORT, () => {
+  console.log(`Listening on port ${PORT}`)
+})

src/items/item.interface.ts

@@ -0,0 +1,5 @@
+export interface Item {
+  name: string;
+  price: number;
+  multiplier: number;
+}

src/items/items.interface.ts

@@ -0,0 +1,5 @@
+import { Item } from './item.interface'
+
+export interface Items {
+  [key: number]: Item
+}

src/items/items.router.ts

@@ -0,0 +1,15 @@
+import express, { Request, Response } from 'express'
+import * as ItemService from './items.service'
+import { Item } from './item.interface'
+
+export const itemsRouter = express.Router()
+
+itemsRouter.get('/', async (req: Request, res: Response) => {
+  try {
+    const items: Item[] = await ItemService.findAll()
+
+    res.status(200).send(items)
+  } catch (e) {
+    res.status(500).send(e.message)
+  }
+})

src/items/items.service.ts

@@ -0,0 +1,32 @@
+import { Item } from './item.interface'
+import { Items } from './items.interface'
+
+const items: Items = {
+  1: {
+    name: 'Bash',
+    price: 10,
+    multiplier: 0.1
+  },
+  2: {
+    name: 'Git',
+    price: 100,
+    multiplier: 1.2
+  },
+  3: {
+    name: 'Javascript',
+    price: 10000,
+    multiplier: 14.0
+  },
+  4: {
+    name: 'React',
+    price: 50000,
+    multiplier: 75.0
+  },
+  5: {
+    name: 'Vim',
+    price: 1000000,
+    multiplier: 10000.0
+  }
+}
+
+export const findAll = async (): Promise<Item[]> => Object.values(items)

tsconfig.json

@@ -0,0 +1,71 @@
+{
+  "compilerOptions": {
+    /* Visit https://aka.ms/tsconfig.json to read more about this file */
+
+    /* Basic Options */
+    // "incremental": true,                         /* Enable incremental compilation */
+    "target": "es5",                                /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', or 'ESNEXT'. */
+    "module": "commonjs",                           /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */
+    // "lib": [],                                   /* Specify library files to be included in the compilation. */
+    // "allowJs": true,                             /* Allow javascript files to be compiled. */
+    // "checkJs": true,                             /* Report errors in .js files. */
+    // "jsx": "preserve",                           /* Specify JSX code generation: 'preserve', 'react-native', 'react', 'react-jsx' or 'react-jsxdev'. */
+    // "declaration": true,                         /* Generates corresponding '.d.ts' file. */
+    // "declarationMap": true,                      /* Generates a sourcemap for each corresponding '.d.ts' file. */
+    // "sourceMap": true,                           /* Generates corresponding '.map' file. */
+    // "outFile": "./",                             /* Concatenate and emit output to single file. */
+    // "outDir": "./",                              /* Redirect output structure to the directory. */
+    // "rootDir": "./",                             /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
+    // "composite": true,                           /* Enable project compilation */
+    // "tsBuildInfoFile": "./",                     /* Specify file to store incremental compilation information */
+    // "removeComments": true,                      /* Do not emit comments to output. */
+    // "noEmit": true,                              /* Do not emit outputs. */
+    // "importHelpers": true,                       /* Import emit helpers from 'tslib'. */
+    // "downlevelIteration": true,                  /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
+    // "isolatedModules": true,                     /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
+
+    /* Strict Type-Checking Options */
+    "strict": true,                                 /* Enable all strict type-checking options. */
+    // "noImplicitAny": true,                       /* Raise error on expressions and declarations with an implied 'any' type. */
+    // "strictNullChecks": true,                    /* Enable strict null checks. */
+    // "strictFunctionTypes": true,                 /* Enable strict checking of function types. */
+    // "strictBindCallApply": true,                 /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
+    // "strictPropertyInitialization": true,        /* Enable strict checking of property initialization in classes. */
+    // "noImplicitThis": true,                      /* Raise error on 'this' expressions with an implied 'any' type. */
+    // "alwaysStrict": true,                        /* Parse in strict mode and emit "use strict" for each source file. */
+
+    /* Additional Checks */
+    // "noUnusedLocals": true,                      /* Report errors on unused locals. */
+    // "noUnusedParameters": true,                  /* Report errors on unused parameters. */
+    // "noImplicitReturns": true,                   /* Report error when not all code paths in function return a value. */
+    // "noFallthroughCasesInSwitch": true,          /* Report errors for fallthrough cases in switch statement. */
+    // "noUncheckedIndexedAccess": true,            /* Include 'undefined' in index signature results */
+    // "noPropertyAccessFromIndexSignature": true,  /* Require undeclared properties from index signatures to use element accesses. */
+
+    /* Module Resolution Options */
+    // "moduleResolution": "node",                  /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
+    // "baseUrl": "./",                             /* Base directory to resolve non-absolute module names. */
+    // "paths": {},                                 /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
+    // "rootDirs": [],                              /* List of root folders whose combined content represents the structure of the project at runtime. */
+    // "typeRoots": [],                             /* List of folders to include type definitions from. */
+    // "types": [],                                 /* Type declaration files to be included in compilation. */
+    // "allowSyntheticDefaultImports": true,        /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
+    "esModuleInterop": true,                        /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
+    // "preserveSymlinks": true,                    /* Do not resolve the real path of symlinks. */
+    // "allowUmdGlobalAccess": true,                /* Allow accessing UMD globals from modules. */
+
+    /* Source Map Options */
+    // "sourceRoot": "",                            /* Specify the location where debugger should locate TypeScript files instead of source locations. */
+    // "mapRoot": "",                               /* Specify the location where debugger should locate map files instead of generated locations. */
+    // "inlineSourceMap": true,                     /* Emit a single file with source maps instead of having a separate file. */
+    // "inlineSources": true,                       /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
+
+    /* Experimental Options */
+    // "experimentalDecorators": true,              /* Enables experimental support for ES7 decorators. */
+    // "emitDecoratorMetadata": true,               /* Enables experimental support for emitting type metadata for decorators. */
+
+    /* Advanced Options */
+    "skipLibCheck": true,                           /* Skip type checking of declaration files. */
+    "forceConsistentCasingInFileNames": true        /* Disallow inconsistently-cased references to the same file. */
+  }
+}