GithubHelp home page GithubHelp logo

arthurpedroti / node-backend-template Goto Github PK

View Code? Open in Web Editor NEW
28.0 2.0 3.0 2.81 MB

A template for NodeJS backend projects

License: MIT License

JavaScript 9.42% TypeScript 89.80% HTML 0.77%
express typescript typeorm aws-ses aws-s3 cache notifications login-system jwt nodemailer

node-backend-template's Introduction

Welcome to my Backend Template 👋

A template for NodeJS backend projects

Languagues Top Languague Repository size Last commit date Repository issues License

Made by Arthur Pedroti Github - Arthur Pedroti Linkedin - Arthur Pedroti Email - Arthur Pedroti Fale comigo no whatsapp - Arthur Pedroti

Description   |    Languages   |    Technologies   |    Databases   |    Install   |    Usage   |    License

Description

This template was coded in Typescript, TypeORM and Express, contains a login with a password recovery system. Also, have a notifications provider with MongoDB and a Redis provider to be used for cache. The recovery password email system was setup with AWS SES for production and the profile avatar setup to be saved with AWS S3.For commits, we setup a config with commitlint/commitizen/husky and for. For code analyses, we are using ESLint and Prettier. For tests, we are using JEST. You can see at the technologies section, all dependencies we are using.

To use this template you will need to configure the files bellow:

  • ormconfig.json
  • .env

It also has an insomnia file with the api docs to test all the login features, only need to reconfigure the "Response => Body Attribute" with the Request route.

Utils: Generating the app_secret: http://www.md5.cz/ (type some random text and generate a hash) AWS credentials: Take it creating a new user on Amazon

💻 Languages

  • #TypeScript

📚 Technologies

  • #Express
  • #TypeORM
  • #ESLint
  • #Prettier
  • #AWS S3
  • #Multer
  • #AWS SES
  • #Celebrate
  • #JWT
  • #Nodemailer
  • #Handlebars
  • #TSringe
  • #ioRedis
  • #rate-limiter-flexible
  • #Commitlint
  • #Commitizen
  • #Husky

🗄️ Databases

  • #Postgres
  • #MongoDB
  • #Redis

Install

Init your repository before install, or you will need to reinstall husky.

yarn install

Usage

yarn dev:server

Author

👤 Arthur Pedroti

🤝 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 © 2020 Arthur Pedroti.
This project is MIT licensed.


Made by 💙 by Arthur Pedroti

node-backend-template's People

Contributors

arthurpedroti avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.