journal

Journal

Written as a first attempt of a web-based project in Go, this is a simple web- server driven blog with the ability to post new entries.

It makes use of a SQLite database to store the journal entries.

API Documentation

Installation and Setup

1. Clone the repository to $GOPATH/src/github.com/jamiefdhurst/journal.
2. Make sure the $GOPATH/data directory exists.
3. Change directory to $GOPATH/src/github.com/jamiefdhurst/journal.
4. Run go get to install dependencies
5. Run go build journal to create the executable.
6. Run ./journal -mode=createdb to create the database.
7. Run ./journal to load the application on port 3000. You should now be able to fully access it at

Options

• -mode=createdb - Use to create the database within the data directory.
• -port=3000 - Use to set the port to serve on for HTTP, defaults to 3000.

Environment Variables

• GIPHY_API_KEY - Must be set to the GIPHY API key to use

Layout

The project layout follows the standard set out in the following document: https://github.com/golang-standards/project-layout

• /api - API documentation
• /cmd/journal - Main Journal executable folder
• /internal/app/controller - Controllers for the main application
• /internal/app/model - Models for the main application
• /internal/app/router - Implementation of router for given app
• /pkg/adapter - Adapters for connecting to external services
• /pkg/controller - Controller logic
• /pkg/database - Database connection logic
• /pkg/router - Router for handling services
• /test - API tests
• /test/data - Test data
• /test/mocks - Mock files for testing
• /web/app - CSS/JS source files
• /web/static - Compiled static public assets
• /web/templates - View templates