https://github.com/masb0ymas/expresso-typeorm

expresso with TypeORM
https://github.com/masb0ymas/expresso-typeorm

aws-s3 expressjs google-cloud-storage ioredis minio nodejs nodemailer repository-pattern rest-api typeorm

Last synced: 26 days ago
JSON representation

expresso with TypeORM

• Host: GitHub
• URL: https://github.com/masb0ymas/expresso-typeorm
• Owner: masb0ymas
• License: mit
• Created: 2021-09-08T14:43:27.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-09-09T05:57:36.000Z (2 months ago)
• Last Synced: 2024-09-10T05:02:34.730Z (2 months ago)
• Topics: aws-s3, expressjs, google-cloud-storage, ioredis, minio, nodejs, nodemailer, repository-pattern, rest-api, typeorm
• Language: TypeScript
• Homepage: https://expresso.masb0ymas.com
• Size: 3.62 MB
• Stars: 7
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# expresso with TypeORM

[![documentation](https://img.shields.io/badge/Documentation-yes-brightgreen.svg)](https://github.com/masb0ymas/expresso-typeorm#readme)

[![maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://github.com/masb0ymas/expresso-typeorm/graphs/commit-activity)

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/masb0ymas/expresso-typeorm/blob/master/LICENSE.md)

[![version](https://img.shields.io/badge/Version-5.0.0-blue.svg?cacheSeconds=2592000)](https://github.com/masb0ymas/expresso-typeorm/releases/tag/v5.0.0)

[![Express](https://img.shields.io/badge/Express-4.19.2-informational?logo=express&color=22272E)](https://expressjs.com/)

![Node](https://badges.aleen42.com/src/node.svg)

![Eslint](https://badges.aleen42.com/src/eslint.svg)

![TypeScript](https://badges.aleen42.com/src/typescript.svg)

![Docker](https://badges.aleen42.com/src/docker.svg)

## Feature

- [TypeScript](https://github.com/microsoft/TypeScript) `5.5.x`

- [TypeORM](https://github.com/typeorm/typeorm) `0.3.x`

- [Nodemailer](https://github.com/nodemailer/nodemailer) `6.x`

- [Handlebars](https://github.com/wycats/handlebars.js) for templating HTML

- [Zod](https://github.com/colinhacks/zod) for validation schema `3.x`

- JavaScript Style [Standard with TypeScript](https://github.com/standard/eslint-config-standard-with-typescript)

- Formating code using [Prettier](https://github.com/prettier/prettier) Integration [Eslint](https://github.com/prettier/eslint-config-prettier) and [TypeScript Eslint](https://github.com/typescript-eslint/typescript-eslint#readme)

- Documentation with [Swagger](https://github.com/swagger-api/swagger-ui) OpenApi `3.x`

- Logger with [Pino](https://github.com/pinojs/pino)

- [Convensional Commit](https://www.conventionalcommits.org/en/v1.0.0/) with [Husky](https://github.com/typicode/husky) & [Commitlint](https://github.com/conventional-changelog/commitlint)

## Note

By Default branch `main` using `type: module`. If you want to use `CommonJS` you must clone the branch `commonjs`

## Steps to run this project:

1. Clone this repository

2. Duplicate `.env.example` to `.env`

3. Setup database settings inside `.env` file

4. Create your database ( manual ) or run `yarn db:create && yarn db:reset`

5. Run `yarn dev` command

6. Run watch command `yarn dev:watch`

7. Enable commitlint with husky `yarn husky install`

8. Release your app for *Production* or *Staging* with `yarn release`

9. Build your code with Docker `docker build -t yourname/express:v1.0.0 .`

10. Run with docker image `docker run -p 7000:8000 -d yourname/express:v1.0.0`

## Author

[**masb0ymas** (Resume)](https://resume.masb0ymas.com)

[![Github](https://badges.aleen42.com/src/github.svg)](https://github.com/masb0ymas)

[![Twitter](https://badges.aleen42.com/src/twitter.svg)](https://twitter.com/masb0ymas)

[![Linkedin](https://img.shields.io/badge/Linkedin-Informational?logo=linkedin&color=0A66C2&logoColor=white)](https://www.linkedin.com/in/masb0ymas)

## Support Me

[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/I2I03MVAI)

[](https://trakteer.id/masb0ymas)

[](https://www.paypal.com/paypalme/masb0ymas)