README
¶
api
Description
API provides HTTP REST API for Orvosi application.
SLI and SLO
- Availability: TBD
- Average response time
POST /sign-in: TBDPOST /medical-records: TBDGET /medical-records: TBDGET /medical-records/:id: TBDPUT /medical-records/:id: TBD
Architecture Diagram
Owner
Onboarding and Development Guide
How to Run
-
Install Go
We use version 1.15. Follow Golang installation guideline.
-
Install PostgreSQL
-
Go to project folder
Usually, it would be
cd go/src/github.com/orvosi/api. -
Run the database
- Make sure to run PostgreSQL.
-
Fill in the environment variables
Copy the sample env file.
cp env.sample .envThen, fill the values according to your setting in
.envfile. -
Download the dependencies
make dep-downloador run this command if you don't have
makeinstalled in your local.go mod download -
Run the database migration
Install
golang-migrate. Follow Golang Migrate CLI.Run the migration command.
make migrate url=<database url>e.g:
make migrate url=postgres://user:password@localhost:5432/orvosi -
Run the application
go run app/api/main.go
Development Guide
-
Fork the project
-
Create a meaningful branch
git checkout -b <your-goal>e.g:
git checkout -b strenghten-security-on-sign-in-process -
Create some changes and their tests (unit test and any test if any).
-
Make sure to have unit test coverage at least 90%. There will be times when the code is quite hard to test. Please, explain it in your Pull Request.
-
Push the changes to repository.
-
Create Pull Request (PR) for your branch. In your PR's description, please explain the goal of the PR and its changes.
-
Ask the other contributors to review.
-
Once your PR is approved and its pipeline status is green, ask the owner to merge your PR.
Request Flows
See Request Flows
Endpoints
See Endpoints
Code Map
See Code Map
Dependencies
- PostgreSQL
Directories
¶
| Path | Synopsis |
|---|---|
|
app
|
|
|
api
command
|
|
|
Package entity defines all core structs or domains of API.
|
Package entity defines all core structs or domains of API. |
|
internal
|
|
|
builder
Package builder provides functionality to build representative flow.
|
Package builder provides functionality to build representative flow. |
|
config
Package config provides the functionality of managing configuration.
|
Package config provides the functionality of managing configuration. |
|
http/handler
Package handler provides the functionality of REST HTTP.
|
Package handler provides the functionality of REST HTTP. |
|
http/middleware
Package middleware provides HTTP middleware
|
Package middleware provides HTTP middleware |
|
http/response
Package response provides data structure to build HTTP JSON response structure.
|
Package response provides data structure to build HTTP JSON response structure. |
|
http/router
Package router provides the functionality routing the HTTP request.
|
Package router provides the functionality routing the HTTP request. |
|
http/server
Package server provides the functionality HTTP server.
|
Package server provides the functionality HTTP server. |
|
repository
Package repository provides real connection to storage.
|
Package repository provides real connection to storage. |
|
tool
Package tool provides tool functionalities Google Idtoken decoder.
|
Package tool provides tool functionalities Google Idtoken decoder. |
|
test
|
|
|
mock/usecase
Package mock_usecase is a generated GoMock package.
|
Package mock_usecase is a generated GoMock package. |
|
Package usecase defines the business logic of the requirements.
|
Package usecase defines the business logic of the requirements. |