nest-js graphql

Author: malforsaja

.env.example

@@ -0,0 +1,4 @@
+DATABASE_URL=<db url>
+DATABASE_NAME=<db name>
+SALT_ROUND=<number i.e 10>
+JWT_SECRET=<jwt secret>

.eslintrc.js

@@ -0,0 +1,25 @@
+module.exports = {
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    project: 'tsconfig.json',
+    tsconfigRootDir: __dirname,
+    sourceType: 'module',
+  },
+  plugins: ['@typescript-eslint/eslint-plugin'],
+  extends: [
+    'plugin:@typescript-eslint/recommended',
+    'plugin:prettier/recommended',
+  ],
+  root: true,
+  env: {
+    node: true,
+    jest: true,
+  },
+  ignorePatterns: ['.eslintrc.js'],
+  rules: {
+    '@typescript-eslint/interface-name-prefix': 'off',
+    '@typescript-eslint/explicit-function-return-type': 'off',
+    '@typescript-eslint/explicit-module-boundary-types': 'off',
+    '@typescript-eslint/no-explicit-any': 'off',
+  },
+};

.gitignore

@@ -0,0 +1,37 @@
+# compiled output
+/dist
+/node_modules
+
+# Logs
+logs
+*.log
+npm-debug.log*
+pnpm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# OS
+.DS_Store
+
+# Tests
+/coverage
+/.nyc_output
+
+# IDEs and editors
+/.idea
+.project
+.classpath
+.c9/
+*.launch
+.settings/
+*.sublime-workspace
+
+# IDE - VSCode
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+
+.env

.prettierrc

@@ -0,0 +1,4 @@
+{
+  "singleQuote": true,
+  "trailingComma": "all"
+}

README.md

@@ -0,0 +1,38 @@
+# Steps to run the project
+Make sure you have installed Node.js and npm on your machine.
+Make sure you have installed MongoDB on your machine or have an URL to access it.
+Create a file .env on the project root folder and add the following variables like on file .env.example
+
+## Installation
+Go to the project folder and run the following command to install all the dependencies.
+```bash
+$ npm install
+```
+
+## Running the app
+Then run the following command to start the server.
+```bash
+# development
+$ npm start
+
+# production mode
+$ npm run start:prod
+```
+
+## Project is running on
+http://localhost:3000/graphql
+
+You may use https://studio.apollographql.com/sandbox/explorer to test the GraphQL APIs.
+    
+
+## Authorization via Header (Bearer Token)
+Authorization header should be in the following format:
+```
+   Authorization: Bearer <access_token>
+``` 
+
+## Improvements to do
+- [] Add unit tests
+- [] Add dockerfile
+- [] Add docker-compose
+- [] Add CI/CD

nest-cli.json

@@ -0,0 +1,8 @@
+{
+  "$schema": "https://json.schemastore.org/nest-cli",
+  "collection": "@nestjs/schematics",
+  "sourceRoot": "src",
+  "compilerOptions": {
+    "deleteOutDir": true
+  }
+}