Skip to content

A boilerplate for node.js application with TypeScript.

Notifications You must be signed in to change notification settings

Pradnyana28/dafis-nodejs-boilerplate

Repository files navigation

Dafis Boilerplate for Node.js 🤠

Dafis Node.js Boilerplate is a personal project by Kadek Pradnyana. It save my time from making the project structures and setup this and that. Inspired by the simplicity of Laravel, and try to make it more simple in Node.js environment. Please feel free to hit me on twitter if you have any thought about this project.

Features 🤗

  • Authentication 📧
  • Email Notification 📩
  • Responsive Template 📱

Tech 💻

This boilerplate uses a number of open source projects: 📂

  • node.js - JavaScript runtime built on Chrome's V8 JavaScript engine.
  • Express - Fast node.js network app framework
  • TypeScript - JavaScript with static type definitions
  • MongoDB - Document-based database
  • axios - Promised based HTTP client
  • faker - Fake contextual data generator
  • nodemailer - Email sending for Node.js
  • passport.js - Simple authentication for Node.js
  • pug - Template engine
  • tailwindcss - A utility-first CSS framework
  • redis - In-memory data structure store
  • laravel-mix - Webpack wrapper

Installation 👨‍🔧

Install the dependencies and devDependencies and start the server.

$ npm install
$ npm run mix
$ nodemon

For production environments...

$ npm install
$ npm run production
$ pm2 start /dist/app.js

Development 👨‍💻

Dafis boilerplate use Webpack and Laravel Mix for fast developing.

Want to contribute? Great! Just Star, and leave a Pull Request.

Docker 🐳

Dafis boilerplate is already has Docker compose file setted up so you can run it easily on any server. Use command below to run.

docker-compose up --build

Todos 📝

  • Make more documentation
  • Add API route
  • Setup redis as middleware
  • Add nginx service to docker
  • Add redis service to docker

License 😄

MIT The MIT License is a permissive free software license originating at the Massachusetts Institute of Technology in the late 1980s. As a permissive license, it puts only very limited restriction on reuse and has, therefore, high license compatibility. It is compatible because it can be re-licensed under other licenses

About

A boilerplate for node.js application with TypeScript.

Resources

Stars

Watchers

Forks

Packages

No packages published