Welcome to express-mongoose-typescript 👋

Just boilerplate Express with Mongoose

🏠 Homepage

Prerequisites

• npm >= v6.x
• node >= v10.x
• eslint >= v7.x
• Familiar with TypeScript 💪

Feature

• TypeScript v4.x
• Mongoose v5.x
• Nodemailer
• Handlebars for templating HTML
• Yup for validation schema
• JavaScript Style Airbnb Base
• Formating code using Prettier Integration Eslint
• Using Babel Resolver for simplify the require/import paths
• Documentation with Swagger
• Generate Log File with Winston

Install

npm install

or

yarn

Usage

npm start

or

yarn start

Run tests

npm test

or

yarn test

Run build

npm run build

or

yarn build

Usage Production

npm run serve:production

or

yarn serve:production

Dump Database Mongo

db=your_database yarn run mongo:dump

Restore Database Mongo

yarn run mongo:restore

SMTP Basic

I use topol.io to create email templates, and it's free and can export to html format

MAIL_DRIVER=smtp
MAIL_HOST=smtp.mailgun.org
MAIL_PORT=465
MAIL_AUTH_TYPE=
MAIL_USERNAME=your_mail@domain.com
MAIL_PASSWORD=your_password
MAIL_ENCRYPTION=null

SMTP Google Oauth Email ( Gmail )

MAIL_DRIVER=gmail
MAIL_HOST=null
MAIL_PORT=null
MAIL_AUTH_TYPE=OAuth2
MAIL_USERNAME=your_account@gmail.com
MAIL_PASSWORD=null
MAIL_ENCRYPTION=null

OAUTH_CLIENT_ID=your_client_id
OAUTH_CLIENT_SECRET=your_client_secret
OAUTH_REDIRECT_URL=https://developers.google.com/oauthplayground
OAUTH_REFRESH_TOKEN=your_refresh_token

Author

👤 masb0ymas

• Website: https://resume.masb0ymas.vercel.app
• Twitter: @masb0ymas
• Github: @masb0ymas
• LinkedIn: @masb0ymas

🤝 Contributing

Contributions, issues and feature requests are welcome!
Feel free to check issues page. You can also take a look at the contributing guide.

Show your support

Give a ⭐️ if this project helped you!

📝 License

Copyright © 2021 masb0ymas.
This project is MIT licensed.

---

This README was generated with ❤️ by readme-md-generator