Skip to content

proyecto26/MyAPI

Repository files navigation

Nest Logo

MyApi SQL Template
⚡️ Launch your api instantly watching changes with live-reload
📈 Highly scalable using Repository design pattern to access the database even easier
😎 OpenAPI with Swagger to describe your RESTful APIs
KISS principle make everything as simple as possible, but not simpler
📱 Mobile friendly supporting Cross-origin resource sharing (CORS) with a list of domains for restricted resources
🔑 Security using JWT authentication strategy with Passport and other techniques to increase the security of your applications
👥 Made for Users. Easily validate permissions for specific routes using Guards with a Role-based access control
Don't repeat yourself, Single responsibility principle.
🔗 Validation: provides pipes available right out-of-the-box with class-validator to enforce validation rules for all incoming client payloads
⚠️ Logger with Winston using different levels to track exceptions easily
🔄 Migrations using TypeORM to apply incremental updates to the database

Demo 🎮

Do you want to see this template in action? Visit https://myapi-template.herokuapp.com/api yay! 🎉

Options (Database Type) 💻

SQL Database NoSQL Database

Installation 📚

# install dependencies
$ yarn

Running the app ▶

# development
$ yarn start

# watch mode
$ yarn start:dev

# production mode
$ yarn start:prod

Running migrations ▶

# run migration
$ yarn migration

# create migration
$ yarn migration:create

# revert migration
$ yarn migration:revert

Test 🕵️

# unit tests
$ yarn test

# e2e tests
$ yarn test:e2e

# test coverage
$ yarn test:cov

TypeORM 📖

Resources 📚

Credits 👍

Star History 🌟

Star History Chart

Sponsors 💜

This project is free and open source. Sponsors help keep it maintained and growing.

Become a Sponsor | Sponsorship Program

Contribution 🤝

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated ❤️.

You can learn more about how you can contribute to this project in the contribution guide.

Happy coding 💯

Made with ❤️ by Proyecto 26 - Changing the world with small contributions.

One hand can accomplish great things, but many can take you into space and beyond! 🌌

Together we do more, together we are more ❤️