WebApp Generator
OPN Generator is a tool to build a new application by providing API specification and Database schema.
Report Bug
Table of Contents
-
About The Project
-
Getting Started
-
Usage
- Roadmap
- Requirements
- 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
- 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
- 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
- Prepare API spec (OpenAPISpec ver.3 YAML file).
- Prepare DB Schema design (PlantUML file).
Installation
- 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
- 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
Acknowledgements
New project will be created in the same directory.
Datadog APM Settings
Datadog APM Settings