Boilerplate Generator - Backend

This application will provide API endpoints to Generate and Download boilerplate code for the various tech stacks.

Requirements

• NodeJS installed

Run Locally

Clone the project

  git clone https://github.com/Hypermona/boilerplate-gen-backend

Go to the project directory

  cd boilerplate-gen-backend

Install dependencies

  npm install

Start the server

  npm start

Tech stacks Supported

• For web

  Client: React, Vue, Svelte

  Server: Node, Express

  DataBase: MongoDB, mysql, postgresql

• For Mobile

  Client: React-native

  Server: Node, Express

  DataBase: MongoDB, mysql, postgresql

Working

• Generating Boilerplate

  • All the frameworks and docker files are stored inside data folder.

  • When user requests a boilerplate new folder will be initialized in the name of project.

  • Also add DBs if required.

  • Then insert required frameworks and docker files.

  • if required generate docker-compose using js-yaml parser.

  • Then send success message to user.

• Downloading Boilerplate

  • Convert the boilerplate into zip file.

  • Then send back to user.

  • Then delete the Boilerplate.

API Reference

Generate frontend

  GET /generate/web/frontend

{
    name: "name of project"
    framework : "react | vue | svelte"
    container : true | false
}

Generate backend

  GET /generate/web/backend

{
    name: "name of project"
    framework : "express"
    db: "mongoDB | mysql | postgresql"
    container : true | false
}

Generate fullstack

  GET /generate/web/fullstack

{
  name: "name of project";
  frontend: "react | vue | svelte";
  backend: "express";
  db: "mongoDB | mysql | postgresql";
  container: true | false;
  compose: true | false; // if container is true then this field is always true
}

[android / ios] only frontend

  GET /generate/mobile/frontend

{
  name: "name of project";
  framework: "react-native";
}

[android / ios] fullstack

  GET /generate/mobile/fullstack

{
  name: "name of project";
  frontend: "react-native";
  backend: "express";
  db: "mongoDB | mysql | postgresql";
}

download boilerplate as zip file

  GET /download

{
  name: "name of project";
}