https://github.com/petrnikolas/node-email-service
Node.js email service
https://github.com/petrnikolas/node-email-service
boilerplate boilerplate-front-end boilerplate-template email-sender email-sending email-server email-template express expressjs node node-js nodejs nodejs-server starter-kit starter-project starter-template typescript typescript-boilerplate
Last synced: 3 months ago
JSON representation
Node.js email service
- Host: GitHub
- URL: https://github.com/petrnikolas/node-email-service
- Owner: PetrNikolas
- Created: 2020-05-29T06:04:48.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2020-05-29T06:07:56.000Z (almost 5 years ago)
- Last Synced: 2025-01-11T10:19:48.715Z (4 months ago)
- Topics: boilerplate, boilerplate-front-end, boilerplate-template, email-sender, email-sending, email-server, email-template, express, expressjs, node, node-js, nodejs, nodejs-server, starter-kit, starter-project, starter-template, typescript, typescript-boilerplate
- Language: TypeScript
- Size: 5.86 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Node.js email service
Node.js email service written in Typescript.
## Libs
- [TypeScript](https://www.typescriptlang.org/index.html#download-links)
- [Node.js v6 and +](https://nodejs.org/en/download/)
- [Express.js](https://expressjs.com/)
- [NPM](https://docs.npmjs.com/getting-started/what-is-npm)
- [totoro-node](https://www.npmjs.com/package/totoro-node)
- [Nodemailer](https://nodemailer.com/about/)
## Project Setup
1. Run `npm install -g typescript`.
2. Run `npm install typescript-eslint-parser -g`.
3. Run `npm i eslint-config-airbnb-base -g`.
4. Run `npm i eslint-plugin-import@latest -g`.
5. Clone this repo.
6. Run `npm install` to install dependencies.
7. Run `npm run serve` for build and serve app.
## Development
- Run `npm run build` to compile TypeScript files to JavaScript.
- Run `npm start` to build the project and visit [http://localhost:3000/](http://localhost:3000/).
Or you can run just only `npm run serve` and visit [http://localhost:3000/](http://localhost:3000/).
## Lint
- Run `npm run lint:ci` to lint your code with TSLint and format code with Prettier.
## Tests
- Run `npm run mocha` for Mocha tests.
- Run `npm run jest` for Jest tests.
## Debug
- Run `npm run debug` for debug your code.
## Documentation
- Documentation is [here.](./Documentation.md)