README - juanitopons/fullstack-test GitHub Wiki

fullstack-test-server - v1.0.0Wiki

fullstack-test-server - v1.0.0

Welcome to fullstack-test-server 👋

Version Documentation License: MIT

Server application ecosystem: NodeJs with typescript, REST api with express and routing controller + class-validator + DI + TypeOrm + ESLint + Prettier + Custom Cron scheduler + Custom Logger configs + Custom npm scripts. Webpack build configured

Prerequisites

  • node >=10.3.0
  • eslint >6.0.0
  • typescript >3.0.0
  • webpack >4.0.0
  • On local deployment, also: mysql5.7 with MYSQL_USER and MYSQL_PASSWORD and MYSQL_DATABASE created
  • On docker deployment: docker and docker compose 1.21.0

Install

npm i

Usage

NODE_ENV=development npm start

Docs

Docs are available in docs server page. Docs generated with TypeDoc

Author

👤 Juan Pons

🤝 Contributing

Contributions, issues and feature requests are welcome!
Feel free to check issues page.

Show your support

Give a ⭐️ if this project helped you!


This README was generated with ❤️ by readme-md-generator

⚠️ **GitHub.com Fallback** ⚠️