feat(api): add project

.eslintrc.json

@@ -18,7 +18,8 @@
               }
             ]
           }
-        ]
+        ],
+        "@typescript-eslint/ban-ts-comment": "off"
       }
     },
     {

.github/ISSUE_TEMPLATE/BUG_REPORT.yml

@@ -1,30 +1,30 @@
-name: 🐞 Bug report
-description: Report a bug in the RealWorld project
-title: '[Bug]: '
-labels:
-  - bug
-assignees:
-  - geromegrignon
-body:
-  - type: dropdown
-    attributes:
-      label: Relevant scope
-      description: What is the scope of this request?
-      options:
-        - Frontend specs
-        - Backend specs
-        - Deployed demo
-        - 'Other: describe below'
-    validations:
-      required: true
-  - type: textarea
-    attributes:
-      label: Description
-      description: A clear and concise description of the problem
-    validations:
-      required: true
-  - type: markdown
-    attributes:
-      value: >-
-        This template was generated with [Issue Forms
-        Creator](https://www.issue-forms-creator.app/)
+name: 🐞 Bug report
+description: Report a bug in the RealWorld project
+title: '[Bug]: '
+labels:
+  - bug
+assignees:
+  - geromegrignon
+body:
+  - type: dropdown
+    attributes:
+      label: Relevant scope
+      description: What is the scope of this request?
+      options:
+        - Frontend specs
+        - Backend specs
+        - Deployed demo
+        - 'Other: describe below'
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Description
+      description: A clear and concise description of the problem
+    validations:
+      required: true
+  - type: markdown
+    attributes:
+      value: >-
+        This template was generated with [Issue Forms
+        Creator](https://www.issue-forms-creator.app/)

.github/ISSUE_TEMPLATE/FEATURE_REQUEST.yml

@@ -1,38 +1,38 @@
-name:  🚀 Feature request
-description: Suggest a feature for RealWorld project
-title: '[Feature Request]:'
-assignees:
-  - geromegrignon
-body:
-  - type: markdown
-    attributes:
-      value: '# Feature Request'
-  - type: dropdown
-    attributes:
-      label: Relevant Scope
-      description: What is the scope of this request?
-      options:
-        - Frontend specs
-        - Backend specs
-        - 'Other: describe below'
-    validations:
-      required: true
-  - type: textarea
-    attributes:
-      label: Description
-      description: ' <!-- ✍️--> '
-    validations:
-      required: true
-  - type: textarea
-    attributes:
-      label: Describe the solution you'd like
-      description: If you have a solution in mind, please describe it.
-  - type: textarea
-    attributes:
-      label: Describe alternatives you've considered
-      description: Have you considered any alternative solutions or workarounds?
-  - type: markdown
-    attributes:
-      value: >-
-        This template was generated with [Issue Forms
-        Creator](https://www.issue-forms-creator.app/)
+name: 🚀 Feature request
+description: Suggest a feature for RealWorld project
+title: '[Feature Request]:'
+assignees:
+  - geromegrignon
+body:
+  - type: markdown
+    attributes:
+      value: '# Feature Request'
+  - type: dropdown
+    attributes:
+      label: Relevant Scope
+      description: What is the scope of this request?
+      options:
+        - Frontend specs
+        - Backend specs
+        - 'Other: describe below'
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Description
+      description: ' <!-- ✍️--> '
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Describe the solution you'd like
+      description: If you have a solution in mind, please describe it.
+  - type: textarea
+    attributes:
+      label: Describe alternatives you've considered
+      description: Have you considered any alternative solutions or workarounds?
+  - type: markdown
+    attributes:
+      value: >-
+        This template was generated with [Issue Forms
+        Creator](https://www.issue-forms-creator.app/)

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,9 +1,11 @@
 ## PR Checklist
+
 Please check if your PR fulfills the following requirements:
 
 - [ ] The commit message follows our guidelines: https://github.com/gothinkster/realworld/blob/master/CONTRIBUTING.md#commit
 
 ## PR Type
+
 What kind of change does this PR introduce?
 
 <!-- Please check the one that applies to this PR using "x". -->
@@ -12,23 +14,19 @@ What kind of change does this PR introduce?
 - [ ] Feature
 - [ ] Other... Please describe:
 
-
 ## What is the current behavior?
+
 <!-- Please describe the current behavior that you are modifying, or link to a relevant issue. -->
 
 Issue Number: N/A
 
-
 ## What is the new behavior?
 
-
 ## Does this PR introduce a breaking change?
 
 - [ ] Yes
 - [ ] No
 
-
 <!-- If this PR contains a breaking change, please describe the impact and migration path for existing applications below. -->
 
-
 ## Other information

.github/dependabot.yml

@@ -1,19 +1,13 @@
 version: 2
 updates:
-- package-ecosystem: github-actions
-  directory: "/"
-  schedule:
-    interval: weekly
-  open-pull-requests-limit: 10
+  - package-ecosystem: github-actions
+    directory: '/'
+    schedule:
+      interval: weekly
+    open-pull-requests-limit: 10
 
-- package-ecosystem: npm
-  directory: "/"
-  schedule:
-    interval: weekly
-  open-pull-requests-limit: 10
-
-- package-ecosystem: npm
-  directory: "/documentation"
-  schedule:
-    interval: weekly
-  open-pull-requests-limit: 10
+  - package-ecosystem: npm
+    directory: '/'
+    schedule:
+      interval: weekly
+    open-pull-requests-limit: 10

.github/workflows/api.yaml

@@ -0,0 +1,34 @@
+name: CI
+
+on:
+  workflow_dispatch:
+  push:
+    branches: [main]
+  pull_request:
+    branches:
+      - '**'
+
+jobs:
+  run_tests:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [12.x]
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v3
+        with:
+          node-version: '16'
+          cache: 'npm'
+      - name: Install dependencies
+        run: npm ci --no-audit --prefer-offline --progress=false
+      - name: Check prettier
+        run: npm run prettier:check
+      - name: Check ESLinter
+        run: npm run lint:check
+      - name: Check unit tests
+        run: npm run test --ci --lastCommit --maxWorkers=50%
+        env:
+          CI: true

.github/workflows/test-documentation.yml

@@ -13,12 +13,8 @@ jobs:
       - uses: actions/setup-node@v3
         with:
           node-version: '16'
-          cache: 'yarn'
-      - name: Run install
-        uses: borales/actions-yarn@v4
-        with:
-            cmd: install
+          cache: 'npm'
+      - name: Install dependencies
+        run: npm ci --no-audit --prefer-offline --progress=false
       - name: Build production bundle
-        uses: borales/actions-yarn@v4
-        with:
-            cmd: nx build documentation
+        run: npx nx build documentation

.gitignore

@@ -4,13 +4,13 @@
 dist
 tmp
 /out-tsc
+_generated_
+
+# Keep environment variables out of version control
+.env
 
 # dependencies
 node_modules
-.yarn/*
-!.yarn/releases
-!.yarn/plugins
-.pnp.*
 
 # IDEs and editors
 /.idea

.husky/.gitignore

@@ -0,0 +1 @@
+_

.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npx lint-staged

.npmrc

@@ -0,0 +1 @@
+legacy-peer-deps=true

.prettierignore

@@ -1,2 +1,3 @@
 .prettierignore
-.docusaurus/
+.docusaurus/
+/dist

.prettierrc

@@ -1,3 +1,7 @@
 {
-  "singleQuote": true
+  "printWidth": 100,
+  "singleQuote": true,
+  "trailingComma": "all",
+  "bracketSpacing": true,
+  "arrowParens": "avoid"
 }

CODE_OF_CONDUCT.md

@@ -17,23 +17,23 @@ diverse, inclusive, and healthy community.
 Examples of behavior that contributes to a positive environment for our
 community include:
 
-* Demonstrating empathy and kindness toward other people
-* Being respectful of differing opinions, viewpoints, and experiences
-* Giving and gracefully accepting constructive feedback
-* Accepting responsibility and apologizing to those affected by our mistakes,
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes,
   and learning from the experience
-* Focusing on what is best not just for us as individuals, but for the
+- Focusing on what is best not just for us as individuals, but for the
   overall community
 
 Examples of unacceptable behavior include:
 
-* The use of sexualized language or imagery, and sexual attention or
+- The use of sexualized language or imagery, and sexual attention or
   advances of any kind
-* Trolling, insulting or derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or email
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email
   address, without their explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
+- Other conduct which could reasonably be considered inappropriate in a
   professional setting
 
 ## Enforcement Responsibilities
@@ -106,7 +106,7 @@ Violating these terms may lead to a permanent ban.
 ### 4. Permanent Ban
 
 **Community Impact**: Demonstrating a pattern of violation of community
-standards, including sustained inappropriate behavior,  harassment of an
+standards, including sustained inappropriate behavior, harassment of an
 individual, or aggression toward or disparagement of classes of individuals.
 
 **Consequence**: A permanent ban from any sort of public interaction within

CONTRIBUTING.md

@@ -85,13 +85,13 @@ Before you submit your Pull Request (PR) consider the following guidelines:
 
 - If we suggest changes then:
 
-    - Make the required updates.
-    - Rebase your branch and force push to your GitHub repository (this will update your Pull Request):
+  - Make the required updates.
+  - Rebase your branch and force push to your GitHub repository (this will update your Pull Request):
 
-      ```bash
-      git rebase master -i
-      git push -f
-      ```
+    ```bash
+    git rebase master -i
+    git push -f
+    ```
 
 That's it! Thank you for your contribution!
 
@@ -127,7 +127,6 @@ from the master (upstream) repository:
 ## <a name="commit"></a> Commit Message Guidelines
 
 > These guidelines have been added to the project starting from <include date>
-> 
 
 We have very precise rules over how our git commit messages can be formatted. This leads to **more
 readable messages** that are easy to follow when looking through the **project history**.
@@ -167,6 +166,7 @@ The version in our package.json gets copied to the one we publish, and users nee
 ### Type
 
 Must be one of the following:
+
 - **docs**: Documentation only changes
 - **feat**: A new feature
 - **fix**: A bug fix
@@ -207,7 +207,7 @@ Close #394
 ```
 
 ```
-BREAKING CHANGE:  
+BREAKING CHANGE:
 change login route to /users/login
 ```