update: "documents" folder to "docs" (#391)

* Rename .github/PULL_REQUEST_TEMPLATE/PULL-REQUEST.md to .github/pull_request_template.md

fix: Pull Request Template Location

* documents -> docs

* Update windows_install.md

Fix: Docker hyperlink

* Update linux_install.md

Fix: Layout (step 6)

* Rename docs/contributions/code_of_conduct.md to CODE_OF_CONDUCT.md

fix: Code of Conduct location according to GitHub's Guide

* Update CODE_OF_CONDUCT.md

Update: Contact info

* Update README.md

Update: Code of Conduct hyperlink in TOC

* Update CODE_OF_CONDUCT.md

Update: Link to ReadMe

* Update CONTRIBUTORS.md

update: add new name to the list

* Update and rename docs/contributions/contributor_guidelines.md to CONTRIBUTING.md

fix: change location according to GitHub's standards

* Delete CONTRIBUTORS.md

delete: contributor.md from root (already present in readme)

* Update SECURITY.md

* Update CONTRIBUTING.md

Update discord link to point to rules

* Update README.md

Update discord link to point to rules

* Update README.md

fix: ToC

docs/dev/Dockerfile-app

@@ -0,0 +1,35 @@
+# ./Dockerfile
+
+FROM node:19-alpine
+WORKDIR /app
+
+# Copy package.json files for client and api
+COPY /client/package*.json /app/client/
+COPY /api/package*.json /app/api/
+COPY /package*.json /app/
+
+# Install dependencies for both client and api
+RUN npm ci
+
+# Copy the current directory contents into the container
+COPY /client/ /app/client/
+COPY /api/ /app/api/
+
+# Set the memory limit for Node.js
+ENV NODE_OPTIONS="--max-old-space-size=2048"
+
+# Build artifacts for the client
+RUN cd /app/client && npm run build
+
+# Create the necessary directory and copy the client side code to the api directory
+RUN mkdir -p /app/api/client && cp -R /app/client/dist /app/api/client/dist
+
+# Make port 3080 available to the world outside this container
+EXPOSE 3080
+
+# Expose the server to 0.0.0.0
+ENV HOST=0.0.0.0
+
+# Run the app when the container launches
+WORKDIR /app/api
+CMD ["npm", "start"]

docs/dev/README.md

@@ -0,0 +1,5 @@
+This directory contains files used for developer work
+
+- Dockerfile-app: used to build the DockerHub image
+- eslintrc-stripped.js: alternate linting rules, used in development
+- meilisearch.yml: Dockerfile for building meilisearch image independently from project

docs/dev/eslintrc-stripped.js

@@ -0,0 +1,90 @@
+module.exports = {
+  env: {
+    browser: true,
+    es2021: true,
+    node: true,
+    commonjs: true,
+    es6: true
+  },
+  extends: ['prettier'],
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    ecmaVersion: 'latest',
+    sourceType: 'module',
+    ecmaFeatures: {
+      jsx: true
+    }
+  },
+  plugins: ['react', 'react-hooks', '@typescript-eslint'],
+  rules: {
+    'react/react-in-jsx-scope': 'off',
+    indent: ['error', 2, { SwitchCase: 1 }],
+    'max-len': [
+      'error',
+      {
+        code: 150,
+        ignoreStrings: true,
+        ignoreTemplateLiterals: true,
+        ignoreComments: true
+      }
+    ],
+    'linebreak-style': 0,
+    // 'arrow-parens': [2, 'as-needed', { requireForBlockBody: true }],
+    // 'no-plusplus': ['error', { allowForLoopAfterthoughts: true }],
+    'no-console': 'off',
+    'import/extensions': 'off',
+    'no-promise-executor-return': 'off',
+    'no-param-reassign': 'off',
+    'no-continue': 'off',
+    'no-restricted-syntax': 'off',
+    'react/prop-types': ['off'],
+    'react/display-name': ['off']
+  },
+  overrides: [
+    {
+      files: ['**/*.ts', '**/*.tsx, **/*.js, **/*.jsx'],
+      rules: {
+        'no-unused-vars': 'off', // off because it conflicts with '@typescript-eslint/no-unused-vars'
+        'react/display-name': 'off',
+        '@typescript-eslint/no-unused-vars': 'warn'
+      }
+    },
+    {
+      files: ['rollup.config.js', '.eslintrc.js', 'jest.config.js'],
+      env: {
+        node: true
+      }
+    },
+    {
+      files: [
+        '**/*.test.js',
+        '**/*.test.jsx',
+        '**/*.test.ts',
+        '**/*.test.tsx',
+        '**/*.spec.js',
+        '**/*.spec.jsx',
+        '**/*.spec.ts',
+        '**/*.spec.tsx',
+        'setupTests.js'
+      ],
+      env: {
+        jest: true,
+        node: true
+      },
+      rules: {
+        'react/display-name': 'off',
+        'react/prop-types': 'off',
+        'react/no-unescaped-entities': 'off'
+      }
+    }
+  ],
+  settings: {
+    react: {
+      createClass: 'createReactClass', // Regex for Component Factory to use,
+      // default to "createReactClass"
+      pragma: 'React', // Pragma to use, default to "React"
+      fragment: 'Fragment', // Fragment to use (may be a property of <pragma>), default to "Fragment"
+      version: 'detect' // React version. "detect" automatically picks the version you have installed.
+    }
+  }
+};

docs/dev/meilisearch.yml

@@ -0,0 +1,10 @@
+version: '3'
+services:
+  meilisearch:
+    image: getmeili/meilisearch:v1.0
+    ports:
+      - 7700:7700
+    env_file:
+      - ./api/.env
+    volumes:
+      - ./meili_data:/meili_data