thuynguyen95 / trivin

⚡️Setup your entire project quickly and easily with 1-line command ⚡️

Trivin made everything simple, fast, and clean

The most well-structured open-source template to build a powerful and clean apps

Trivin is a free and open-source project that bootstrap everything you need to deploy your full-stack application. It consists of clean and quality code, which is suggested by industry engineers.

Getting Started

Installation

Install trivin with this one-line command

npm i trivin -g

Requirements

• NodeJS >= 10.x
• NPM >= 6.x

Quick Overview

$ trivin myapp -g -i

? Please choose which project template to use
❯ mern
  node-passport-jwt
  react
  simple-node-server

  ✔ Copy Project files
  ✔ Initialize git
  ✔ Install all dependencies. This could take around 1~2 minutes.

Initialized M.E.R.N project with MongoDB Atlas/Google App Engine setup
DONE Project ready

Feature

• Choose a template. Default template: MERN

$ trivin <app-name> <app-template>

• -g: git init for your project
• -i: Install all dependencies for both React and Node folders
• ESLint Airbnb Config + Prettier
• Securely Authenticate/Authorize APIs with Passport-JWT
• Works on macOS, Windows, and Linux.

Project

• Include Redux Dev Tools Config (You need to install this extension on your browser)

• React project is well-structured with Redux-thunk/React-router/Axios

• Authenticate/authorize with Passport-jwt

• Database: MongoDB is hosted on MongoDB Atlas

• Mailing API for multiple purposes using Nodemailer and Google OAuth Client

Become a Trivin Contributor

1. Fork the repo

2. Create a folder with your Template-name and add all files to that folder

3. Add your template name to Choices.

   • IMPORTANT: The name should be the same

4. Practicing pushing to your branch and create a PR with Github CLI

   • Check out how to use new Github CLI here.

5. Trivin team will review your code, and approve/request changes.

Upcoming Feature

• Testing

• README for each template

• Deployment: Choices to deploy app with Google App Engine/Heroku

Help/Supports

• Join Trivin's Slack Channel and ask any questions here

• If something doesn’t work, please file an issue here.

Learning

Node Setup with Passport-jwt Authorization

• Medium Instruction. Code found here

React + Redux-thunk + Router Setup

• Medium Instruction. Code found here

Very Simple Node.js setup

• Medium Instruction. Code found here

Multi-purpose API

• Medium Instruction

License

This project is open-sourced software licensed under the ISC License. See the LICENSE file for more information.