maya-manager / server Goto Github PK

Project

Core

Description

include all the major technologies used in this project

Anything else?

No response

Description

route:

[POST] /auth/login

body:

{
  "email": "[email protected]",
  "username": "username",
  "password": "strong password"
}

Validations

1. Users can either log in with either a username or email
2. If the user is not verified then he should not be able to log in

Anything else?

No response

here is example of issue templates

Github docs to create issue templates:

Make a pull request template with this body

# Description

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.

Fixes #(issue)

# Checklist:

-   [ ] I have performed a self-review of my own code
-   [ ] I have commented my code, particularly in hard-to-understand areas
-   [ ] I have made corresponding changes to the documentation (postman and swagger)
-   [ ] I have written tests for the code

# Screenshots (optional)

official docs on how to create pull request template: https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/creating-a-pull-request-template-for-your-repository

Project

Server

Description

We need to implement a logger that will log all the requests and uncaught exceptions and errors

Anything else?

How to implement global error logger:- https://blog.devops.dev/throw-like-a-pro-in-nestjs-6b4dca2b935c

scroll down to step 4

create a new file .github/workflows/deploy-docs.yml and paste the following contents

name: Build and Deploy
on:
    push:
        branches:
            - main
    workflow_dispatch:
permissions:
    contents: write
jobs:
    build-and-deploy:
        concurrency: ci-${{ github.ref }} # Recommended if you intend to make multiple deployments in quick succession.
        runs-on: ubuntu-latest
        steps:
            - name: Checkout 🛎️
              uses: actions/checkout@v3

            - name: Install and Build 🔧 # This example project is built using npm and outputs the result to the 'build' folder. Replace with the commands required to build your project, or remove this step entirely if your site is pre-built.
              run: |
                  yarn install
                  yarn docs

            - name: Deploy 🚀
              uses: JamesIves/github-pages-deploy-action@v4
              with:
                  folder: docs # The folder the action should deploy.

Project

Server

Description

Setup PostgreSQL with node js server

Anything else?

No response

Project

Core

Description

Add following things in the REAMDE

1. Add section to invite users to official discord server
2. Basic details about monorepos and how to use yarn workspaces

Anything else?

Discord invite link: https://discord.com/invite/A2GdYbwAnw
Yarn workspaces: https://yarnpkg.com/features/workspaces

Description

Create a route that will resend the forgot password verification code

Anything else?

No response

Project

Core

Description

This will include following contents

1. Forking and cloning the repo
2. Downloading and setting up database (don't need to write everything just add reference to official docs)
3. Installing packages
4. Adding .env file

and everything else needed to get started with the development process

Anything else?

No response

Description

Create a route /auth/signup/resend/:email this route will resend the verification code to the provided email.

verification code can be taken from user.verification_code from database

Anything else?

No response

setup following tools

• eslint
• typedoc
• commit lint
• git husky

reference to config files can be found in this repo: https://github.com/MultiEmail/frontend

Eslint

use this config file and please install all the packages needed to make this configuration work

{
	"env": {
		"es2021": true,
		"node": true,
		"jest": true
	},
	"parser": "@typescript-eslint/parser",
	"plugins": [
		"@typescript-eslint",
		"prettier",
		"sonarjs",
		"no-secrets",
		"jsonc",
		"pii",
		"no-unsanitized"
	],
	"extends": [
		"google",
		"prettier",
		"plugin:sonarjs/recommended",
		"plugin:node/recommended",
		"plugin:jsonc/base",
		"plugin:pii/recommended",
		"plugin:no-unsanitized/DOM",
		"plugin:prettier/recommended",
		"plugin:@typescript-eslint/recommended"
	],
	"parserOptions": {
		"ecmaVersion": 2020,
		"sourceType": "module"
	},
	"settings": {
		"import/resolver": {
			"typescript": {}
		}
	},
	"rules": {
		"semi": "error",
		"no-console": "warn",
		"no-tabs": "off",
		"indent": "off",
		"space-infix-ops": "off",
		"no-trailing-spaces": "error",
		"space-before-blocks": "error",
		"quotes": "off",

		"camelcase": "error",
		"node/no-unpublished-import": "off",
		"node/no-unsupported-features/es-syntax": "off",
		"node/no-missing-import": [
			"error",
			{
				"allowModules": [],
				"resolvePaths": ["/path/to/a/modules/directory"],
				"tryExtensions": [".js", ".ts", ".json", ".node"]
			}
		],
		"valid-jsdoc": "off",
		"node/handle-callback-err": "error",
		"node/no-path-concat": "error",
		"node/no-process-exit": "error",
		"node/global-require": "error",
		"node/no-sync": "error",
		"no-secrets/no-secrets": "error",
		"pii/no-email": "off",
		"no-invalid-this": "off",
		"spaced-comment": "off",
		"prefer-destructuring": ["error", { "object": true, "array": true }],
		"@typescript-eslint/no-explicit-any": "off",
		"no-unused-vars": "off",
		"@typescript-eslint/no-unused-vars": [
			"warn",
			{ "argsIgnorePattern": "req|res", "varsIgnorePattern": "prop" }
		],
		"@typescript-eslint/ban-types": [
			"error",
			{
				"types": {
					// un-ban a type that's banned by default
					"{}": false
				},
				"extendDefaults": true
			}
		],
		"linebreak-style": "off",
		"object-curly-spacing": "off",
		"comma-dangle": "off",
		"new-cap": "off",
		"require-await": "error",
		"require-jsdoc": "off",
		"sonarjs/cognitive-complexity": "off",
		"sonarjs/no-duplicate-string": "off",
		"sonarjs/no-identical-expressions": "off",
		"sonarjs/no-identical-functions": "off",
		"@typescript-eslint/quotes": ["error", "double"],
		"@typescript-eslint/ban-ts-comment": "off",
		"@typescript-eslint/explicit-function-return-type": "off",
		"prettier/prettier": [
			"error",
			{
				"endOfLine": "auto",
				"useTabs": true
			}
		]
	}
}

Project

Core

Description

• #13
• #14
• #15
• #16

Anything else?

No response

You can add your self for contribution by using @all-contributors

check out their docs: https://allcontributors.org/docs/en/bot/usage

Current Behavior

There are 2 major problems

1. Extra margin around the banner
2. Text in button is not centered

Expected Behavior

1. There should be no extra unexpected margins
2. Text inside the button should be centered

Steps To Reproduce

1. Create a new account
2. Check your mail box

Anything else?

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

This repository currently has no open or pending branches.

Detected dependencies

• Check this box to trigger a request for Renovate to run again on this repository

Description

Create a rate-limiter middleware that will only allow 150 requests per 15 minutes from a single device

Anything else?

nestjs rate limiter:- https://docs.nestjs.com/security/rate-limiting

Project

Server

Description

The verification email that is currently being sent while signing up is not looking good so we need to create an email template with our custom HTML and CSS

Anything else?

No response

Description

create a route [GET] /auth/verify/:email/:verification_code

After signup, an API call will be made to this route to verify the verification code sent to the user's email

Anything else?

No response