README
¶
Go Qlueless API
***Discontinued: archived for reference only.***
A Go implementation of a simple API to store and access Kanban related entities and events.
- This project is undertaken with the audible aid of Avantasia and Dream Theater
- This README was structured on a template by PurpleBooth
Why is the project called 'Qlueless'?
I apologise, it's a poor play on words attempting to combine:
Clueless: One of the projects purposes is to learn and experiment with technologies such as Go, React, and public pipeline tools; I'm moderately clueless about the latter two.Queueless: I want to experiment with ways of visualising and emphasising work in progress that is not, in fact, being progressed, i.e. half finished work sitting in queues waiting for someone to finish them. Once visible and being measured I can start to analyze it, and experiment with ways of reducing and avoiding it!
Getting Started
Prerequisites
- Go: [https://golang.org/dl/]
- Git: [https://git-scm.com]
- An internet connection
- A decent web browser
Running
Navigate to a suitable directory, open a terminal, and copy+paste the following:
git clone https://github.com/PaulioRandall/go-qlueless-api.git
cd go-qlueless-api/scripts
./build-test-api-run.go
In order, this will:
- Clone the source code repository
- Navigate to the user
scriptsdirectory - Execute a build of the OpenAPI specification
- Execute a build of the application
- Execute unit tests within the application
- Execute black box API tests on the application
- Starts the application
Running unit tests
Open a terminal at the project root:
cd /scripts
./build-test.go
Running API tests
Open a terminal at the project root:
cd /scripts
./build-test-api.go
Deployment
Coming soon! See Running in the meantime.
Built With
Contributing
Not applicable.
Versioning
This projects API CHANGELOG format is based on Keep a Changelog, and the API adheres to Semantic Versioning.
Authors
License
This project is licensed under the MIT License.
Acknowledgments
- Influences
- 'The Goal' by Eliyhahu M. Goldratt
- Continuous Integration
- Continuous Delivery
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
changelog
Package changelog provides handlers for fetching the API changelog for the API.
|
Package changelog provides handlers for fetching the API changelog for the API. |
|
database
database package provides a shared database for the whole application.
|
database package provides a shared database for the whole application. |
|
home
Package home provides handlers for returning API entry point content and handling requests to undefined endpoints.
|
Package home provides handlers for returning API entry point content and handling requests to undefined endpoints. |
|
openapi
Package openapi provides handlers for fetching the OpenAPI specification for the service.
|
Package openapi provides handlers for fetching the OpenAPI specification for the service. |
|
std
std package provides functions, types, and resources that are shared by the API implementation.
|
std package provides functions, types, and resources that are shared by the API implementation. |
|
ventures
Package ventures collects together the handling of all Venture specific requests.
|
Package ventures collects together the handling of all Venture specific requests. |
|
shared
|
|
|
wrapped
Package wrapped provides a structure and functions for containing and processing wrapped responses and errors.
|
Package wrapped provides a structure and functions for containing and processing wrapped responses and errors. |
|
writers
Package writers provides reusable HTTP response writing functionality.
|
Package writers provides reusable HTTP response writing functionality. |
Click to show internal directories.
Click to hide internal directories.