webapp-generator

README

WebApp Generator

OPN Generator is a tool to build a new application by providing API specification and Database schema.

Report Bug

Table of Contents

1. About The Project
   • Project Structure
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Requirements
6. Acknowledgements

About The Project

Project Structure

📦opn-generator
 ┣ 📂cmd
 ┣ 📂config
 ┣ 📂internal
 ┃ ┣ 📂generators
 ┃ ┣ 📂handlers
 ┃ ┣ 📂services
 ┣ 📂out
 ┃ ┣ 📂db
 ┃ ┗ 📂temp
 ┣ 📂pkg
 ┃ ┣ 📂database_schema
 ┃ ┣ 📂files
 ┃ ┣ 📂open_api_spec
 ┃ ┣ 📂template

This tool is developed by following Standard Go project layout

Getting Started

You can use MacOS, Linux or Windows as operating system to use this tool. To get a local copy up and running follow these simple steps.

Prerequisites

1. Make sure Git is installed. To verify that you've installed Git by opening a command prompt and typing the following command that prints the installed version of Git.

   $ git version
   

2. Make sure GO is installed. To verify that you've installed Go by opening a command prompt and typing the following command that prints the installed version of Go.

   $ go version
   

3. Prepare API spec (OpenAPISpec ver.3 YAML file).
4. Prepare DB Schema design (PlantUML file).

Installation

1. Clone - Go to a folder where you would like to clone this tool and run following.

   $ git clone https://github.com/takaaki-mizuno/webapp-generator.git
   

2. Build - Go to the opn-generator directory and run following.

   $ go build
   

Usage

To use OPN Generator after the installation succeed, please use the following command that will build a new application

$ ./opn-generator new [projectName] --database [/path/to/plantUMLFile] --api [/path/to/apiSpecYAMLFile]

Here,
[projectName] is name of the project
--database is the file path of database plantuml file,
--api is the file path of API specification file.

To check sample files of API specification and Database schema, have a look over here

Roadmap

The roadmap is useful for planning large pieces of work several months in advance at the Epic level within a single project. Simple planning and dependency management features help teams visualize and manage work better together.

See the open issues for a list of proposed features (and known issues).

Requirements

• Go^1.15

Acknowledgements

• Dig
• Cobra
• Testify
  And many more

New project will be created in the same directory.

Datadog APM Settings

Datadog APM Settings

Documentation

Overview

Copyright © 2021 NAME HERE <EMAIL ADDRESS>

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.