phuctm97 / go-restful Goto Github PK

View Code? Open in Web Editor NEW

77.0 9.0 15.0 77 KB

🚀 A real world production-grade RESTful Web Services proof-of-concept project.

License: Apache License 2.0

Go 71.85% Shell 8.01% Dockerfile 20.14%

proof-of-concept restful web-services clean-architecture go golang docker vscode go-modules

go-restful's Introduction

Go RESTful

🚀 A real world production-grade RESTful Web Services proof-of-concept project.

Objectives

An optimized Go implementation follows The Clean Architecture, provides mechanism to declare Entities, Use cases, and External Services (e.g. data access).
An optimized Go implementation provides mechanism to expose Entities and Use Cases as RESTful Web Services.
An optimized Go implementation of Token-based Authentication and Authorization.
An optimized Go implementation provides abstract mechanism to access Relational Databases.
An optimized Go Development Environment with Git, Docker, Go Modules, Go Debuggers (GDB/Delve) and popular code editors (VSCode/GoLand/Vim).
An optimized CI/CD Solution with Github Actions and AWS.
An optimized Distribution Solution with Github Releases and Github Package Registry.
A scalable and highly-available Production Deployment Solution over AWS using Terraform.
An optimized Staging Environment replicating Production Environment for testing purposes.
An optimized Issues Tracking mechanism with Github Project, Issues and Pull Requests.
Continual improvements.

Issues Tracking

This project use Github project, issues and pull requests to manage and track issues. Refer to this Github project for further details.

Development

Requirements

Local development machines need to have following tools installed and working properly:

Docker for running a full-time containerized development environment.
Visual Studio Code with Remote - Containers extension for writing code with Intellisense, running and debugging code within containers.

Windows users need to additionally have an Unix-shell emulator to be able to run utility scripts (Git Bash is recommended).

Usage

Develop with Visual Studio Code

With all of above requirements fullfiled, developers can experience a full-time local-quality VSCode-powered containerized development environment by just opening the repository in VSCode container mode.

Go here for further details.

Develop without Visual Studio Code

Without VSCode, developers will not be able to achieve a full-time local-quality VSCode-powered containerized development environment. However, if there's any reason that you can not or do not want to work with Visual Studio Code, you can still start a containerized development environment and start working on that or even build your own development solution on top of that.

Go here for further details.

Project structure

Quick overview of project structure, components and their roles.

├── 📁.vscode/              # VSCode configurations.
├── 📦common/               # Common, utility Go components.
├── 📁docs/                 # Documentation & assets.
├── 📁scripts/              # Utility scripts.
├── 📦users/                # Users-related Go components.
├── 📄.devcontainer.json    # VSCode Remote-Containers configuration.
├── 📄.gitignore
├── 📄Dockerfile            # Instructions to build development Docker image.
├── 📄go.mod                # Go module configuration.
├── 📄go.sum                # Go module checksum/lock.
├── 📖LICENSE
├── 📖README.md
├── 🚀main.go               # Application's main entry point.

License

This project is licensed under the Apache License 2.0 and is available for free.

go-restful's People

Contributors

Stargazers

Watchers

Forkers

rajeshsamson ashim-kr-saha ruwanego hieu-ht treg zelfick delphi1977 anhchuyen lokialice zxy12 ppfearn hoojinguyen bhanukiranchaluvadi kashipai noppong-tr

go-restful's Issues

Document how to use start development with VSCode, Docker and VSCode Remote-Containers

Motivation

Developers know how to use VSCode, Docker and VSCode Remote-Containers properly.

Implement a simple HTTP view as PoC

Motivation

Get to know how to declare HTTP views and handle HTTP requests in Go.
Select a package (or some packages) to achieve HTTP features.
Define a mechanism to declare HTTP views.

Forward GPG actions with dev container to local GPG-agent

Motivation

To be able to do GPG signing Git commits within dev containers and directly with VSCode Git features.

Fix "VSCode Ask to Reopen in Container" image size in documentation

Motivation

Change height to max-height so that the documentation looks properly in small screen size.

Fix missing of gocode-gomod which leads to missing Analysis tool in VS Code

Motivation

VS Code reports missing Go Analysis Tool.

Document base directory structure

Motivation

Developers know what responsibilities that specific files or directories take and know which they should focus on when they're resolving specific issues.

Move development documentation to separate link to shorten main README

Motivation

To shorten main README for ease of reading, just leave core idea in main README and have links referencing to separate documents.

Update Objectives in README.md as some technologies updated

Motivation

Some new better technologies were released and updated and should be put into or replace old components in Objectives section.

Improve dev container configuration to remove duplicate fields such as workspaceFolder and appPort

Motivation

To have consistent field values, easy for maintain and update.

For now, fields workspaceFolder, workspaceMount and appPort are duplicated in .devcontainer.json, Dockerfile and scripts/start-devcontainer.sh, it's okay to work and don't care about those fields at all but it's painful when coming to update and maintain those.

Support VSCode remote container development

Motivation

Be able to use container as full-time development environment with local-quality VSCode development experience — including full IntelliSense (completions), code navigation, and debugging.

Implement user unique validation

Motivation

To ensure user's username and email are unique as specified in requirements.

Implement startup script to launch Docker development environment and mount source code to it

Motivation

Developers can easily launch development environment and mount source code from their local machine to it.

Fix out-of-date go tools and launch devcontainer script

Motivation

Package gopls was out-of-date and need to be updated.
start-devcontainer.sh can not run container because of syntax mistakes.

Force VSCode UI extensions to be used in UI only

Motivation

To mute improper notifications of VS Code.

Write unit tests for user entities

Motivation

To experiment with Go unit tests.
To have user entities unit tests.

Support go-dep as dependency management

Motivation

To have proper Go dependency management.

Acceptance criteria

go-dep installed and usable in dev container.
dep ensure should be run once VSCode Remote-Containers attached containers.
.gitignore should be updated appropriately.
.vscode/settings.json should be updated appropriately to ignore auto-generated files.

Improve configurations, remove redundant redirect stderr, improve VSCode config

Motivation

Remove redundant rediirect in Dockerfile to help it more readable.
Update .gitignore to ignore __debug_bin.
Auto format on save in VSCode.

Switch to Go Modules

Motivation

Go Modules has been official released and applied.

Fix VSCode Remote-Containers workspace mount

Motivation

Local workspace is currently mounted to default directory defined by VSCode Remote-Containers (/workspaces/go-restful), which is a wrong location for a Go package.

Local workspace should be mounted to /go/src/github.com/the-evengers/go-restful instead.

Username: unique, only allow digits, underscores, dashes, dots and alphabetical letters, begins with an underscore or alphabetical letter, at least 1-character length and at most 32-character length.
Email: valid and unique.
Full name: at least 1-character length and at most 128-character length.
Bio: optional, at most 256-character length.

Unique validation should not be implemented now, because it involves interface adapters, which need to be defined later.

phuctm97 / go-restful Goto Github PK

go-restful's Introduction

Go RESTful

Objectives

Issues Tracking

Development

Requirements

Usage

Develop with Visual Studio Code

Develop without Visual Studio Code

Project structure

License

go-restful's People

Contributors

Stargazers

Watchers

Forkers

go-restful's Issues

Recommend Projects

Recommend Topics

Recommend Org