This is an API template made with express and typescript, to speed up your development, it contains repositories and generic services for the typical CRUD actions, based on a Sequelize model, we use it for data persistence
ORM: Sequelize
Language: Typescript
Framework: Express
Database: mySql
Deploy: Vercel,
Auth: JWT
Documentation: Swagger
![GitHub Last Commit](https://camo.githubusercontent.com/3a11515c8b2c7548b9c6259449527928e26e419cae4f99a20f670035dc999658/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c6173742d636f6d6d69742f496d524c6f70657a41472f466f726765742d50726f6a656374)
![Ts-Standard](https://camo.githubusercontent.com/d781bb188111da0339043ae81420ca93d07e2dba7fed093fe7c21ba636dac1e6/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f54732d2d5374616e646172642d3331373843363f6c6f676f3d74797065736372697074266c6f676f436f6c6f723d7768697465)
git clone https://github.com/ImRLopezAG/Ts-Api-Template.git
cd my-project
npm install my-project
cd my-project
yarn install my-project
cd my-project
pnpm install my-project
you need to configure .env file like the .env.dev also you can add your configuration
Body |
Type |
Description |
username |
string |
Required. username |
password |
string |
Required. password |
GET /api/Entity/Get/${id}
Parameter |
Type |
Description |
id |
string |
Required. Id of item to fetch |
Body |
Type |
Description |
Entity Properties |
Entity |
Required. properties of item to fetch |
Parameter |
Type |
Description |
id |
string |
Required. Id of item to update |
Body |
Type |
Description |
Entity Properties |
Entity |
Required. properties of item to put |
Delete /api/Entity/Delete
Parameter |
Type |
Description |
id |
string |
Required. Id of item to delete |
Parameter |
Type |
Description |
id |
string |
Required. Id of item to fetch |
GET /api/User/email/${email}
Parameter |
Type |
Description |
email |
string |
Required. Id of item to fetch |
GET /api/User/username/${username}
Parameter |
Type |
Description |
username |
string |
Required. Id of item to fetch |
Body |
Type |
Description |
email |
string |
Required. |
username |
string |
Required. |
password |
string |
Required. |
Put /api/User/Update/${id}
Parameter |
Type |
Description |
id |
string |
Required. |
Body |
Type |
Description |
email |
string |
Required. |
username |
string |
Required. |
password |
string |
Required. |
Delete /api/User/Delete/${id}
Parameter |
Type |
Description |
id |
string |
Required. |
![twitter](https://camo.githubusercontent.com/512d0d5b4ce59118463471af08f474c77a9414dbb926dbad6073ac56378a12e3/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f747769747465722d3144413146323f7374796c653d666f722d7468652d6261646765266c6f676f3d74776974746572266c6f676f436f6c6f723d7768697465)