Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/olliecoleman/alloy
Boilerplate for creating web applications in Go (golang)
https://github.com/olliecoleman/alloy
golang web-app webpack
Last synced: 3 months ago
JSON representation
Boilerplate for creating web applications in Go (golang)
- Host: GitHub
- URL: https://github.com/olliecoleman/alloy
- Owner: olliecoleman
- License: mit
- Created: 2017-09-08T11:45:38.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2017-11-30T16:38:31.000Z (almost 7 years ago)
- Last Synced: 2024-06-20T11:11:51.475Z (5 months ago)
- Topics: golang, web-app, webpack
- Language: Go
- Homepage: https://www.growthmetrics.io/open-source/alloy
- Size: 482 KB
- Stars: 369
- Watchers: 18
- Forks: 28
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Alloy
Alloy is a starter template for creating web applications using Go programming language.
It does not aim to be a web framework but is instead a collection of useful libraries and packages that acts a sensible starting point.
Recently, I decided to build my latest [side project](https://www.growthmetrics.io) using Go. I started off with just the standard library and then gradually added a few recommended packages for performing common tasks like database calls (sqlx), migrations (pressly/goose) and sending emails (gomail). This boilerplate has been extracted from that side project.
Alloy uses **Webpack** for managing front-end assets (Javascript and CSS), so you need to have Node.js and NPM installed in order to use that. This boilerplate also includes a separate 'admin panel' which acts as a CMS for adding pages, managing users etc.
> *\* GrowthMetrics is a nifty little tool to measure your business's customer satisfaction using a metric called NPS (Net Promoter Score). You can signup for the early access (and early bird discount) here - [https://www.growthmetrics.io/beta](https://www.growthmetrics.io/beta).
** NOTE: ** Currently this uses Postgres as the database, so you would need postgres to be running before you start the application. In future releases, I will be adding support for other databases.
### Packages used
- go-chi/chi
- lib/pq
- jmoiron/sqlx
- markbates/pop/nulls
- gorilla/sessions
- gorilla/csrf
- gorilla/securecookies
- markbates/refresh
- microcosm-cc/bluemonday
- pkg/errors
- pressly/douceur
- pressly/goose
- satori/go.uuid
- spf13/cobra
### Available commands
```
Usage:
alloy [command]
Available Commands:
db Manage the app's database (create migration, migrate up/down/redo).
dev Start the development server (along with webpack watch)
gen-key Generate a random key to use with securecookies
help Help about any command
new-admin Manage the admin user(s)
server Start the server
version Print the version number of alloy
```
### Installation and usage
1. Clone the repository
```
git clone https://github.com/olliecoleman/alloy
cd alloy
```
2. Install the dependencies
```
glide install
npm install
```
3. Create the following environment variables.
```
PORT=1212
ENVIRONMENT=development (change to 'production' in the production environment)
HOST=localhost
DATABASE_URL=XXX (replace)
TEST_DATABASE_URL=XXX (replace)
MIGRATIONS_DIR=app/migrations
CSRF_KEY=XXX (replace with 32 character string (use the gen-key command))
HASH_KEY=XXX (replace with 64 character string (use the gen-key command))
BLOCK_KEY=XXX (replace with 32 character string (use the gen-key command))
SMTP_HOST=127.0.0.1
SMTP_PORT=1025
SMTP_USERNAME=__REPLACE__
SMTP_PASSWORD=__REPLACE__
MAILER_FROM=XXX (e.g: [email protected])
MAILER_HOST=http://localhost:1212
ASSET_URL=http://localhost:1212 (if you are using a CDN in production, this can be set to that URL)
```
3. Start the development server
```
go install
alloy dev
```
Now you can open your browser and navigate to http://localhost:1212 to see it in action. Any changes you make to the .go files will be automatically picked up and the app will be re-compiled.
### Project structure
```
├── README.md
├── app
│ ├── handlers
│ ├── mailer
│ ├── migrations
│ ├── models
│ ├── router
│ │ ├── middleware
│ │ └── router.go
│ ├── services
│ │ ├── db.go
│ │ └── session.go
│ ├── templates
│ │ ├── admin
│ │ ├── layouts
│ │ ├── mailer
│ │ ├── pages
│ └── views
├── assets
│ ├── fonts
│ ├── images
│ ├── js
│ └── scss
│ ├── admin
│ ├── frontend
│ └── frontend.scss
├── cmd
├── testutils
├── glide.yaml
├── main.go
├── package.json
├── refresh.yml
└── webpack.config.js
```
### Screenshots
----------
If you have any questions or comments, please get in touch via email or open an issue. I would welcome your suggestions and pull requests.
Oliver Coleman
coleman.oliver[at]icloud[dot]com
https://www.growthmetrics.io