voitd/express-mongodb-rest-api-boilerplate

A boilerplate for Node.js apps / Rest API / Authentication from scratch - express, mongodb (mongoose). Typescript

express-mongodb-rest-api-typescript-boilerplate

Also express-graphql-mongodb-boilerplate - GraphQL API Boilerplate - OLD SOURCE

Authentication from scratch TypeScript

Sign In, Sign Up, Reset Password, Update Profile, Update Password, Update Email, Delete Profile.

Reset Password by E-mail, Verification Profile by E-mail, Signed Out Access Token blacklisting by Redis,

Image Upload, Multi language.

Package list

Package	Description
ts-node	TypeScript execution and REPL for node.js, with source map and native ESM support.
ts-node-dev	It restarts target node process when any of required files changes (as standard node-dev) but shares Typescript compilation process between restarts. This significantly increases speed of restarting comparing to node-dev -r ts-node/register ..., nodemon -x ts-node ... variations because there is no need to instantiate ts-node compilation each time.
tsc-alias	Replace alias paths with relative paths after typescript compilation. You can add aliases that reference other projects outside your tsconfig.json project by providing a relative path to the baseUrl.
tsconfig-paths	Use this to load modules whose location is specified in the paths section of tsconfig.json or jsconfig.json. Both loading at run-time and via API are supported.
typescript	TypeScript is a language for application-scale JavaScript. TypeScript adds optional types to JavaScript that support tools for large-scale JavaScript applications for any browser, for any host, on any OS
cross-env	Run scripts that set and use environment variables across platforms
express	Fast, unopinionated, minimalist web framework for Node.js.
email-templates	Create, preview (browser/iOS Simulator), and send custom email templates for Node.js. Made for Forward Email and Lad.
nodemailer	Easy as cake e-mail sending from your Node.js applications
ejs	Embedded JavaScript templates
cors	CORS is a node.js package for providing a Connect/Express middleware that can be used to enable CORS with various options.
bcrypt	A library to help you hash passwords.
dotenv	Dotenv is a zero-dependency module that loads environment variables from a .env file into process.env. Storing configuration in the environment separate from code is based on The Twelve-Factor App methodology.
http-status-codes	Constants enumerating the HTTP status codes. Based on the Java Apache HttpStatus API.
i18next	i18next is a very popular internationalization framework for browser or any other javascript environment (eg. Node.js, Deno).
i18next-http-middleware	This is a middleware to be used with Node.js web frameworks like express or Fastify and also for Deno.
jsonwebtoken	An implementation of JSON Web Tokens.
mongoose	Mongoose is a MongoDB object modeling tool designed to work in an asynchronous environment. Mongoose supports Node.js and Deno (alpha).
randomstring	A module for generating random strings
redis	A modern, high performance Redis client
validator	A library of string validators and sanitizers.
winston	A logger for just about everything.
eslint	An AST-based pattern checker for JavaScript.
eslint-config-prettier	Turns off all rules that are unnecessary or might conflict with Prettier.
eslint-plugin-import	This plugin intends to support linting of ES2015+ (ES6+) import/export syntax, and prevent issues with misspelling of file paths and import names. All the goodness that the ES2015+ static module syntax intends to provide, marked up in your editor.
eslint-plugin-prettier	Runs Prettier as an ESLint rule and reports differences as individual ESLint issues.
eslint-plugin-unicorn	More than 100 powerful ESLint rules
prettier	Prettier is an opinionated code formatter

Redis

Mac (using homebrew):

brew install redis

Linux:

sudo apt-get install redis-server

Firstly

yarn install

COPY .env.example to .env

cp .env.example .env

API Start

yarn start
yarn watch # watch mode
yarn build # production build

ESlint Start

yarn lint
yarn lint:write # with prefix --fix

Prettier Start

yarn prettier
yarn prettier:write # with prefix --fix

API Endpoints

• POST: http://localhost:8000/auth/sign-in Sign In
• POST: http://localhost:8000/auth/sign-up Sign Up
• GET: http://localhost:8000/auth/sign-out Sign Out
• POST: http://localhost:8000/auth/password/reset Reset Password
• POST: http://localhost:8000/auth/password/new/:accessToken New Password By Reset
• GET: http://localhost:8000/me Get User
• POST: http://localhost:8000/user/verification/request Verification Request
• GET: http://localhost:8000/user/verification/:accessToken Verify
• POST: http://localhost:8000/user/update Update User
• POST: http://localhost:8000/user/update/email Update Email
• POST: http://localhost:8000/user/update/password Update Password
• POST: http://localhost:8000/user/delete Delete Profile
• POST: http://localhost:8000/media/image/upload Image upload

Note: For any question issues

License

This project is an open-source with an MIT License