Easily extendible RESTful API boilerplate aiming to follow idiomatic go and best practice.

The goal of this boiler is to have a solid and structured foundation to build upon on.

The following feature set is a minimal selection of typical Web API requirements:

• Configuration using viper
• CLI features using cobra
• dep for dependency management
• PostgreSQL support including migrations using go-pg
• Structured logging with Logrus
• Routing with chi router and middleware
• JWT Authentication using jwt-go in combination with passwordless email authentication (could be easily extended to use passwords instead)
• Request data validation using ozzo-validation
• HTML emails with gomail

• Clone this repository
• Create a postgres database and set environment variable DATABASE_URL accordingly if not using same as default
• Build the application: go build to create go-base binary or use go run main.go instead in the following commands
• Run go-base for cobra generated help message.
• Initialize the database migrations table: go-base migrate init
• Run all migrations found in ./database/migrate with: go-base migrate
• Run the application: go-base serve

For passwordless login following routes are available:

Besides /auth/* the API provides to main routes /api/* and /admin/* to distinguish between application and administration features. The latter requires to be logged in as administrator by providing the respective JWT in Authorization Header.

Check routes.md file for an overview of the provided API routes.

For demonstration of the login and account management features this API also serves a Single Page Application (SPA) as a Progressive Web App (PWA) done with Quasar Framework which itself is powered by Vue.js. The client's source code can be found here.

If no valid email smtp settings are provided by environment variables, emails will be print to stdout showing the login token. Use one of the following users for login:

• [email protected] (has access to admin panel)
• [email protected]

A deployed version can also be found on Heroku

Any feedback and pull requests are welcome and highly appreciated. Please open an issue first if you intend to send in a larger pull request or want to add additional features.