proyecto26 / myapi

A template to create awesome APIs easily ⚡️

	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! 🎉

• API for MercadoPago Checkout: https://github.com/proyecto26/mercadopago-api

Options (Database Type) 💻

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 📖

• Relations
• Find Options
• Query Builder

Resources 📚

• Implementing Microservices
• A microservice that handles the queue of sending emails
• Testing with NestJS like a Pro

Credits 👍

• typescript-starter: Nest framework TypeScript starter repository.

Supporting 🍻

I believe in Unicorns 🦄 Support me, if you do too.

Donate Ethereum, ADA, BNB, SHIBA, USDT, DOGE:

Wallet address: 0x3F9fA8021B43ACe578C2352861Cf335449F33427

Please let us know your contributions! 🙏

Happy coding 💯

Made with ❤️

myapi's Issues

Suggestion

I suggest to you add an env example

Cannot build this project

If I run command npm run build, I get following error:

`src/controllers/user.controller.ts:102:5 - error TS2322: Type 'IUser[]' is not assignable to type 'User[]'.
Type 'IUser' is not assignable to type 'User'.

102 return users
~~~~~~~~~~~~
src/repositories/user/user.service.ts:88:38 - error TS2345: Argument of type 'IUser' is not assignable to parameter of type 'User'.
Property 'roleId' is missing in type 'IUser' but required in type 'User'.

88 const newUser = this.preloadUser(user)
~~~~

src/models/user.ts:114:3
114 roleId!: number
~~~~~~
'roleId' is declared here.
src/repositories/user/user.service.ts:129:38 - error TS2345: Argument of type 'IUser' is not assignable to parameter of type 'User'.

129 const newUser = this.preloadUser(user)
~~~~
src/repositories/user/user.service.ts:158:5 - error TS2322: Type '{ roleId: string; documentTypeId: string; id: string; firstName: string; lastName: string; birthdate?: string; address?: string; email: string; password?: string; phoneNumber?: string; termsAndConditions?: boolean; ... 4 more ...; documentType: DocumentType; }' is not assignable to type 'User'.
Types of property 'roleId' are incompatible.
Type 'string' is not assignable to type 'number'.

158 return newUser
~~~~~~~~~~~~~~

Found 4 error(s).`