README
¶
GoCore
A Golang solution of tools for building a full stack web application.
Goals of the Project
Below are some targeted goals:
- Http & Https Redirection & HTTP 2.0 with Golang 1.8 and gin-gonic/gin
- Extension packages for common functions including:
- File IO Management & Manipulation
- Zip File Compression & Decompression
- Database extensions and drivers for the following:
- Supported databases:
- MongoDB
- BoltDB
- Create SQL Schema (DDL) from JSON Configuration.
- Create Golang ORM packages for RDBMS Transactions & Queries.
- Supported databases:
Getting Started
Install Golang
Get GoCore
-
To start a new project with GoCore run the following steps in a new console window.
go mod init github.com/your_example/repo_projectgo get github.com/DanielRenne/GoCore@v1.0.2
Add to your Operating Systems Path the ~/go/bin directory
Build GoCore App
-
A sample project generator is available to build a GoCore project.
go install github.com/DanielRenne/GoCore/core/goCoreCreateApp
Then run
goCoreCreateApp
Follow the prompts to generate your app and it will copy the templates found in GoCore/tools/appFiles into your project directory github.com/username/appName. Note you probably should install nodejs, npm and nvm before generating an app.
GoCore has built in functions to read json configuration files to generate SQL Tables, indexes, primary & foreign keys, NOSQL Collections & Buckets, auto-generated Golang model code files, auto-generated REST web api code files, and swagger.io schema files application. See BuildCore Readme for details.
Run Your GoCore App
-
Run the following to start your app
bash bin/start_app
Open a web browser to: http://127.0.0.1:8080
Login as admin/admin and setup application roles etc. More documentation to come later on application specific setup.
How to build your own web project in GoCore
See Application Settings within docs for information on what webConfig.json allows for.
IMPORTANT NOTE for HTTPS (TLS) Security
GoCore comes default with an open ssl generated Cert and PEM files that are NOT secret as they are available via the open source repository. Make sure you replace both these files located in the keys directory. To do this we recommend in Linux running the following command and copying the output files to the keys directory. Alternatively cert and pem files generated by a valid Certificate Authority like GoDaddy or Verisign when you reach production with an online domain.
openssl req -x509 -nodes -days 365 -newkey rsa:2048 -keyout key.pem -out cert.pem
NOTE: We also recommend NOT to store your secret key files in source control. We recommend ignoring the keys directory for source control.
NOTE: key files are ingored when running getCore as to not overwrite your keys.
Additional Info on Golang https: https://www.kaihag.com/https-and-go/
Building a Database Model with SQLite3
####NOTE: Because SQLite3 requires gcc externally we separated the driver for compiling reasons. Windows users we recommend installing gcc as a prerequisite for the sqlite3 golang module to compile via tdb-gcc. Be sure to install 64 bit for 64 bit machines.
####More SQLite tools to verify your data in Windows SQLite Studio
To create a SQLite3 Database schema and model package for your application run the following:
go install github.com/DanielRenne/GoCore/buildCoreLite
Then run
buildCoreLite
References
Directories
¶
| Path | Synopsis |
|---|---|
|
Debug functions.
|
Debug functions. |
|
app/api
api provides an API router and controller Registry to route controller api's.
|
api provides an API router and controller Registry to route controller api's. |
|
atomicTypes
Package atomicTypes provides object locking / unlocking for setting and getting.
|
Package atomicTypes provides object locking / unlocking for setting and getting. |
|
dbServices/mongo
command
|
|
|
fileCache
Package fileCache will provide simple file content caching tools for in-Memory access to files.
|
Package fileCache will provide simple file content caching tools for in-Memory access to files. |
|
goCoreCreateApp
command
|
|
|
store
Package store provides a registry and interface to interact with a store repository against model entities.
|
Package store provides a registry and interface to interact with a store repository against model entities. |
|
cmdExec
module
|
|
|
cron
module
|
|
|
dbServices/example
module
|
|
|
debouncer
module
|
|
|
mongo
module
|
|
|
path
module
|
|
|
workQueue
module
|
|
|
tools
|
|
|
appFiles/bin
command
|
|
|
appFiles/controllerRegistry
Package controllerRegistry imports new packages to init for controller Registry purposes.
|
Package controllerRegistry imports new packages to init for controller Registry purposes. |
|
appFiles/controllers
Package app provides html routing & rendering for a go core app
|
Package app provides html routing & rendering for a go core app |
|
appFiles/controllers/store
Package store provides an API into the DB GoCore Store operations.
|
Package store provides an API into the DB GoCore Store operations. |
|
appFiles/errors
Package errors provides tools to print stack traces
|
Package errors provides tools to print stack traces |
|
appFiles/install
command
|
|
|
appFiles/networks
Package networks provides information on the computers network and ip scanning tools.
|
Package networks provides information on the computers network and ip scanning tools. |
|
appFiles/settings
Package settings provides settings for go files to reference paths and other constants to know where files are located.
|
Package settings provides settings for go files to reference paths and other constants to know where files are located. |