README
¶
web-starter 
A boilerplate generator for web application
Its build on top of cobra and go-input for cmd line interaction
Pre-requisite
Usage
$ go get -u github.com/cuttle-ai/web-starter
$ web-starter web-server generate
# Will ask few questions regarding the project name , description etc
Project name
Enter a value (Default is Web Server):
Project description
Enter a value (Default is Backend server):
Author name
Enter a value (Default is cuttle.ai):
Author email
Enter a value (Default is hi@cuttle.ai):
Project destination
Enter a value (Default is /home/melvin/go/src/github.com/hi/web-server):
Package name
Enter a value (Default is github.com/hi/web-server):
Type of license
1. AGPL-3
2. BSD-2
3. BSD-3
4. CLOSED
5. GPL-2
6. MIT
7. UNLICENSED
Enter a number (Default is 6):
Copyright year
Enter a value (Default is 2019):
Organisation
Enter a value (Default is Cuttle.ai):
Installing Web Server
# Now we generated and installed the project with name web-server. We can run it by the following command
$ web-server
2019/08/07 23:15:13 INFO: Starting the server at :8080
Help
web-starter help
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
{{.Name}} {{.Description}}
|
{{.Name}} {{.Description}} |
|
config
Package config will have necessary configuration for the application
|
Package config will have necessary configuration for the application |
|
log
Package log is used to print logs based of log types
|
Package log is used to print logs based of log types |
|
routes
Package routes has the routes supported by the api with proper versioning done Suppose a route is /list, it belonged to v2 and current version is v2.
|
Package routes has the routes supported by the api with proper versioning done Suppose a route is /list, it belonged to v2 and current version is v2. |
|
routes/response
Package response handles utilities for writing error and normal responses to the response writer
|
Package response handles utilities for writing error and normal responses to the response writer |
|
version
Package version has the version information about the application
|
Package version has the version information about the application |
|
Package cmd have the commands offered by web-starter application
|
Package cmd have the commands offered by web-starter application |
|
web-server
Package web-server has the commands for web server
|
Package web-server has the commands for web server |
|
Package project has the definitions and implementations required for setting up the project.
|
Package project has the definitions and implementations required for setting up the project. |
|
Package version has the version information about the application
|
Package version has the version information about the application |
Click to show internal directories.
Click to hide internal directories.