https://github.com/droxey/makefeedback

https://github.com/droxey/makefeedback

Last synced: 5 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/droxey/makefeedback
• Owner: droxey
• License: mit
• Created: 2019-01-15T23:38:57.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2019-01-29T21:49:06.000Z (over 7 years ago)
• Last Synced: 2024-06-21T03:19:17.370Z (almost 2 years ago)
• Language: Go
• Size: 192 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# makefeedback

[![Go Report Card](https://goreportcard.com/badge/github.com/droxey/makefeedback)](https://goreportcard.com/report/github.com/droxey/makefeedback) [![Maintainability](https://api.codeclimate.com/v1/badges/5104166591c02873f974/maintainability)](https://codeclimate.com/github/droxey/makefeedback/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/5104166591c02873f974/test_coverage)](https://codeclimate.com/github/droxey/makefeedback/test_coverage) [![feedback](https://img.shields.io/badge/dynamic/json.svg?url=https://raw.githubusercontent.com/droxey/makefeedback/master/assets/badge.json&query=$.feedback&label=feedback&colorB=087CB8)](https://github.com/droxey/makefeedback)

## Tutorial Outline

### Install Prerequisites

1. Golang

1. [Postgres.app 11](https://postgresapp.com/)

### Receiving the Requirements

1. `TODO`: List of requirements here.

### Creating the Business Rules

1. `TODO`: List of business rules distilled from prior step.

### Imagining the UI

#### Slack Integration

[![UX Mockup - Slack](ux-mockup.svg)](ux-mockup.svg)

#### Shields.io Integration

[![UX Mockup - Shield](ux-mockup-shield.svg)](ux-mockup-shield.svg)

### Diagramming the Architecture

[![Architecture Diagram](makefeedback-architecture.svg)](makefeedback-architecture.svg)

### Setting Up the Project

1. Implement [Standard Go Project Layout](https://github.com/golang-standards/project-layout).

### Modeling the Domain Using Golang

### Exposing a Function on the Command Line

### Persisting Data to a Database

### Writing Tests and Benchmarking an Implementation

### Refactoring Based on Performance

### Expose Functionality via API

### Deploying a Go API

### Integrating the API with Slack

### Integrating the API with Shields.io

### Stretch Challenges

1. What other third-party services could you integrate your API with?

1. Can you make this project work for other types of feedback?

1. Can you create a front-end Single Page Application that uses your API?