README
¶
Bookclub
Go micro-service REST API
Explore the docs »
View Demo
·
Report Bug
·
Request Feature
Table of Contents
About The Project
Work in Progress
I'm learning Go. This is my attempt at creating a micro-service web application.
I'm following the ardanlabs/service video course to learn more about how to create idiomatic Go web applications, with inspirations from other resources (see Acknowledgements).
Built With
- Go
- Docker
Getting Started
To get a local copy up and running follow these steps.
Prerequisites
You'll need:
- Go > 1.11 (for Go module support)
- Docker, docker-compose
- GNU make
Installation
-
Clone the repo
git clone https://github.com/sophiabrandt/go-bookclub.git -
Use the Makefile for running commands:
# tidies and vendors dependencies make tidy
I'm using Linux to develop this application - no guarantees for cross-platform compatibility. If you can't get make working, try to copy the necessary commands from the Makefile.
Usage
coming soon
Roadmap
See the open issues for a list of proposed features (and known issues).
Contributing
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.
Please update tests if necessary.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
License
Distributed under the Apache 2.0 License. See LICENSE for more information.
Contact
Sophia Brandt - @hisophiabrandt
Project Link: https://github.com/sophiabrandt/go-bookclub
Acknowledgements
Directories
¶
| Path | Synopsis |
|---|---|
|
app
|
|
|
handlers
packag handlers contains all the route handlers for the application
|
packag handlers contains all the route handlers for the application |
|
business
|
|
|
logger
package logger handles structural logging for the application.
|
package logger handles structural logging for the application. |
|
mid
package mid contains the middleware functions for the application.
|
package mid contains the middleware functions for the application. |
|
cmd
|
|
|
foundation
|
|
|
web
package web implements a small web framework extension for the application.
|
package web implements a small web framework extension for the application. |