uberswe/golang-base-project uberswe/golang-base-project

  • Stars
    star
    246
  • Rank 164,226 (Top 4 %)
  • Language
    Go
  • License
    ISC License
  • Created almost 3 years ago
  • Updated over 1 year ago
Twitter logo Share LinkedIn logo Share Facebook logo Share
uberswe/golang-base-project
github

uberswe

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

A minimal Go project with user authentication ready out of the box. Uses Bootstrap 5 for the frontend. All frontend assets are less than 100 kB on every page load.

Golang Base Project

Archived

I am no longer maintaining this project. As an alternative consider checking out pocketbase.

GoDoc

A minimal Golang project with user authentication ready out of the box. All frontend assets should be less than 100 kB on every page load.

See a live example at: https://www.golangbase.com

Projects that used this template as a starting point:

Functionality includes:

  • Login
  • Logout
  • Register
  • User Activation
  • Resend Activation Email
  • Forgot Password
  • Admin Dashboard
  • Search
  • Throttling

This easiest way for me to achieve this was with a database. I decided to use GORM which should fully support MySQL, PostgreSQL, SQLite, SQL Server and Clickhouse or any other databases compatible with these dialects.

The frontend is based off of examples from https://getbootstrap.com/docs/5.0/examples/.

Getting started

You can run this with go by typing go run cmd/base/main.go and the entire project should run using an sqlite in-memory database.

You can also use Docker.

Docker

A dockerfile and docker compose file is provided to make running this project easy. Simply run docker-compose up.

You will need to change the env variables for sending email, when testing locally I recommend Mailtrap.io.

If you want to change the docker-compose file I recommend making a copy and overriding the base file with your own file like so docker-compose -f docker-compose.yml -f docker-compose.local.yml up --build -d.

Environment variables

This project uses environment variables and there are several ways to set them. If you are using docker see the article Environment variables in Compose. Twilio has a more general guide on how to set environment variables for Windows, Mac OS and Linux.

The following variables can currently be set:

PORT

Port sets the port that the application should listen on for HTTP requests. A common port is 8080 and if you run the application locally you should see the application at http://localhost:8080.

BASE_URL

This url is mainly used for emails since it is considered unsafe to fetch the current url from headers. This should be set to url of the domain you are hosting the project on.

COOKIE_SECRET

This is the key used to authenticate the cookie value using HMAC. It is recommended to use a key with 32 or 64 bytes. This will default to a random 64 byte key if no value is set. Please read more about keys on gorilla/securecookie.

If you don't set this to a value you might get an error like ERROR! securecookie: the value is not valid this is because a new key is generated every time you start the application and you have old cookies in your browser with an invalid HMAC.

DATABASE

The database you would like to use such as mysql or sqlite. See the GORM documentation for more supported databases.

DATABASE_HOST

The database host is usually localhost if running on the same machine or the container name, db in our case, if running with docker. If you have a remote database host you would set this to the ip or domain of that host.

DATABASE_PORT

The port of the database host.

DATABASE_USERNAME

Username used to authenticate to the database.

DATABASE_PASSWORD

Password used to authenticate to the database.

SMTP_USERNAME

Username used for authentication when sending emails over SMTP. For local development you can try using a free service like Mailtrap.io.

SMTP_PASSWORD

Password used for authentication when sending emails over SMTP.

SMTP_HOST

Host used for sending emails over SMTP.

SMTP_PORT

The port for the host used for sending emails over SMTP.

SMTP_SENDER

This will be the email shown in the From: field in emails.

STRICT_TRANSPORT_SECURITY

This will enable or disable strict transport security which sets a header that forces SSL. Read more about HSTS here.

REQUESTS_PER_MINUTE

Used for throttling requests on authentication related endpoints. This value is how many times requests can be made per minute. Set to 5 by default.

CACHE_PARAMETER

This parameter is added to the end of static assets like so /assets/js/main.js?c=rLWjPDCQTh. A random one is set by default every time the application starts but you can set the CACHE_PARAMETER variable if you would like to control this in some other way.

CACHE_MAX_AGE

Sets the max-age time in seconds for the Cache-Control header. By default this header is set to 1 year.

Project structure

This is the latest way I like to organize my projects. It's something that is always evolving and I know some will like this structure while others may not and that is ok.

I have mixed in the frontend assets with the go project. The /src folder has js and css assets for the frontend which are compiled and put into /dist where all the html templates also are.

I create packages when I feel there is a need for them to be shared at different levels of the project such as in another package or the routes, my rules here are very flexible and I have yet to come up with a good rule. Packages are in folders like /middleware, email, util and config.

You can run this project with a single go file by typing go run cmd/base/main.go.

There is a /models package which contains all the database models.

The /routes package contains all the route functions and logic. Typically, I try to break of the logic into other packages when functions become too big but I have no strict rule here.

All in all I have tried to keep the project simple and easy to understand. I want this project to serve as a template for myself and perhaps others when you want to create a new website.

Dependencies

I have tried to keep the dependencies low, there is always a balance here in my opinion and I have included the golang vendor folder and compiled assets so that there is no need to download anything to use this project other than the project itself.

Go Dependencies

The following dependencies are used with Go.

  • Gin - A web framework which makes routes, middleware and static assets easier to use and handle.
  • GORM - An ORM library to make writing queries easier.

NPM Dependencies

I personally dislike NPM because I there seems to be so many dependencies in javascript projects often with vulnerabilites which are hard to fix. However, npm is also one of the easiest ways to build an optimized frontend today which can be modified and built upon by others. I have tried to keep dependencies low and most are only used for the compiling of the static assets.

  • Bootstrap 5 - Bootstrap 5 is a frontend framework that makes it easy to create a good looking website which is responsive.
  • Webpack - An easy way to bundle and compile assets.
  • sass-loader - To compile scss files from bootstrap together with custom styles added by me.
  • PurgeCss - PurgeCss removes unused CSS so that we only load what is needed. Since we have Bootstrap our compiled css would be around 150kB without PurgeCSS compared to around 10kB as it is now.

There are some more dependencies but I have focused on mentioning those that have the greatest impact on the project as a whole.

GitHub Actions

There is a workflow to deploy to my personal server whenever there is a merge to master. This is the way I like to deploy for personal projects. The steps are:

  • Make a new image with docker
  • Push this image to a private container registry on my server, you can see the registry here https://registry.beubo.com/repositories/20
  • Then I use docker-compose to pull the latest image from the private registry

I use supervisor with docker-compose to run my containers. Caddy handles the SSL configuration and routing. I use Ansible to manage my configurations.

Translations

This project uses go-i18n to handle translations. Only English and Swedish is currently supported, but I would gladly add more languages if someone would like to contribute.

To update languages first run goi18n extract to update active.en.toml. Then run goi18n merge active.*.toml to generate translate.*.toml which can then be translated. Finally, run goi18n merge active.*.toml translate.*.toml to merge the translated files into the active files.

Documentation

See GoDoc for further documentation.

Contributions

Contributions are welcome and greatly appreciated. Please note that I am not looking to add any more features to this project but I am happy to take care of bugfixes, updates and other suggestions. If you have a question or suggestion please feel free to open an issue. To contribute code, please fork this repository, make your changes on a separate branch and then open a pull request.

For security related issues please see my profile, @uberswe, for ways of contacting me privately.

License

Please see the LICENSE file in the project repository.

More Repositories

1

go-plugin-benchmark

Benchmark comparing the go plugin package to other plugin implementations
Go
28
star
2

beubo

Beubo is a free, simple, and minimal CMS with unlimited extensibility using plugins
Go
21
star
3

Tarkov-Map-Overlay

A simple application to show you a map while playing Tarkov
C#
16
star
4

nordeago

NordeaGo is a wrapper for the Nordea Open Banking API written in Go
Go
12
star
5

uptime

A simple go program which checks if your websites are running and runs forever (stop it with ctrl+c). It takes two optional arguments, comma separated string with urls and an interval.
Go
12
star
6

WHMCS-Affiliates-Anywhere

This was originally sold by via Anveto under the name Anveto Affiliates Anywhere and Anveto Affiliates Anywhere Plus but I have decided to make it free and open source the addon. You are free to contribute and use the code as long as you abide by the MIT license.
PHP
11
star
7

triangulate

This was the source code for triangulate.xyz which is used to create computer generated art. Written with Golang and ReactJS.
JavaScript
10
star
8

golang-cryptotracker

Simple Go script to track cryptocurrency portfolio value
Go
6
star
9

multiquery

A simple tool to run MySQL queries on multiple databases and return the results.
Go
6
star
10

WHMCS-Slack

A WHMCS addon for sending messages to Slack based on WHMCS hooks. Version 3.0 has been updated for WHMCS 7.5.1 and should still be compatible with older releases back to 6.0.0.
PHP
6
star
11

WHMCS-Licensing-Addon-C-Tester

This was originally sold by via Anveto but I have decided to make it free and open source the addon. You are free to contribute and use the code as long as you give credit to me and abide by the MIT license.
C#
6
star
12

html

html is a go library for generating html components such as buttons, form fields, forms, tables and more using golang.
Go
5
star
13

twitchbot

A web application to allow users to make their own Twitch chat bots
Go
3
star
14

WHMCS-EU-Cookie-Law-Compliance

This was originally sold by via Anveto but I have decided to make it free and open source the addon. You are free to contribute and use the code as long as you give credit to me and abide by the MIT license.
PHP
3
star
15

bittrex-trading-bot

A Simple Cryptocurrency Trading Bot Written With Go
Go
3
star
16

uberblock

A Bitcoin full node stats page with the ambition to become a block explorer
Go
3
star
17

domains-sweden

Old Repository for domäner.xyz - a website which makes it possible to search all Swedish .se and .nu domains
Go
2
star
18

WHMCS-Affiliates-Anywhere-Wordpress

The wordpress plugin for WHMCS Affiliates Anywhere
PHP
2
star
19

smssalesexample

An example of a customer feedback bot to rate and get text input regarding past sales via text messaging written in go.
Go
2
star
20

pixelvideo

A simple example of how to use the pixel 2D game library to make a video
Go
2
star
21

bcrypt_fun

A simple website to generate Bcrypt hashes from strings
HTML
2
star
22

go-lua-table-parser

A simple package which takes a lua table as input and parses it to a map[string]interface{} where interface{} is either more map[string]interface{} or map[string]string
Go
1
star
23

MDHSchedule

Repo for MDH Schedule
Objective-C
1
star
24

WHMCS-Currency-Rates

This was originally sold by via Anveto under the name Anveto Currency Rates but I have decided to make it free and open source the addon. You are free to contribute and use the code as long as you give credit to me and abide by the MIT license.
PHP
1
star
25

interval

Interval is a Go package which uses Golangs time.Duration to perform different functions. For example calling another function at set intervals
Go
1
star
26

copy

Copy copies files and directories recursively
Go
1
star
27

game-of-bots

Game of Bots is a web based multiplayer game with a vanilla js frontend and a Node.js + express.js backend. Webhooks are used for communication.
JavaScript
1
star
28

Download-Image-Urls-In-CSV

A simple command line tool to download any images from urls in csv files located in the same directory as this application. Simple put this file in a new directory and copy paste any CSV files into that same directory. The application will look for and validate any urls and then proceed to download all of the files into a new images folder. This is a tool I used to download images from clients Textalk installations where there is no direct file access.
Objective-C
1
star
29

EggRoll

This game is a 2D tile based sidescroller with slopes developed for the Windows Phone 7.0 with XNA. Both the touchscreen and accelerometer can be used to controll the player. The player starts out as an egg whom has to get as far as possible through the endless level of the game. The game uses an algorithim to constantly generate and update the level as the player walks through it.
C#
1
star
30

automilephp

A class to connect to the automile API via curl
PHP
1
star