Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/masb0ymas/express-functions-typescript

Firebase Cloud Function with Express and TypeScript
https://github.com/masb0ymas/express-functions-typescript

express firebase firebase-functions functions typescript

Last synced: 12 days ago
JSON representation

Firebase Cloud Function with Express and TypeScript

Awesome Lists containing this project

README

        

Welcome to express-functions-typescript 👋



Version



Documentation


Maintenance


License: MIT

> Firebase Cloud Function with Express and TypeScript

## Prerequisites

- npm >= `v6.x`
- node >= `v12.x`
- eslint >= `v7.x`
- Familiar with TypeScript 💪

## Feature

- [TypeScript](https://github.com/microsoft/TypeScript) `v4.x`
- [Nodemailer](https://github.com/nodemailer/nodemailer)
- [Handlebars](https://github.com/wycats/handlebars.js) for templating HTML
- JavaScript Style [Airbnb Base](https://github.com/airbnb/javascript/tree/master/packages/eslint-config-airbnb-base)
- Formating code using [Prettier](https://github.com/prettier/prettier) Integration [Eslint](https://github.com/prettier/eslint-config-prettier)
- Using [Babel Resolver](https://github.com/tleunen/babel-plugin-module-resolver) and [Module Alias](https://github.com/ilearnio/module-alias) for simplify the require/import paths
- Documentation with [Swagger](https://github.com/swagger-api/swagger-ui)
- Generate Log File with [Winston](https://github.com/winstonjs/winston)

## Install

```sh
yarn
```

## Run Type Check

```sh
yarn type-check
```

## Run Linter with ESLint

```sh
yarn lint
```

## Usage

```sh
yarn serve:ts
```

## Run deploy function

```sh
yarn deploy
```

## Author

👤 **masb0ymas**

* Website: https://resume.masb0ymas.vercel.app
* Twitter: [@masb0ymas](https://twitter.com/masb0ymas)
* Github: [@masb0ymas](https://github.com/masb0ymas)
* LinkedIn: [@masb0ymas](https://linkedin.com/in/masb0ymas)

## Show your support

Give a ⭐️ if this project helped you!

***
_This README was generated with ❤️ by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_