Restobook

Online Restaurant Booking

Nowadays, restaurant dont have the assurance whether a customer who booked a table will actually come at the booking time or not. With this app, restaurant could see the reputation of the user who's trying to book a table, and will also get a compensation if the customer failed to come at the booking time.
Wireframe · Entity Relationship Model · Use Case · OpenApi · Project Boards

Table of Content

1. About The Project
2. High Level Architecture
3. Technology Stack
   • Backend
   • Framework
   • Package
   • Database
   • Deployment
   • Collaboration
4. Folder Structure
5. Unit Test
6. How To Contribute
7. Contacts

(back to top)

High Level Architecture

(back to top)

Technology Stack

Framework

• Echo (Go web framework)

Package

• Gorm (ORM library)
• Xendit (Payment gateway)
• Imgur (Image uploader)
• UniDoc (PDF creator)
• Xuri (Excel creator)
• Ftp (Export file)
• Google Calendar (Event creator)
• Testify (Unit Test)

Database

• MySQL (Open source database)

Deployment

• Docker (Container images)
• Okteto (Kubernetes platform)
• Kubernetes (Container Orchestration)

Collaboration

• Trello (Manage projects)
• Github (Cloud-based Git repository)

(back to top)

Structuring

  Restobook
  ├── configs                
  │     └──config.go           # Configs files
  ├── delivery                 # Endpoints handlers or controllers
  │     ├──common
  │     │   ├── global.go           # Constant variable
  │     │   └── http_responses.go   # Default http code, status, message
  │     ├──controllers
  │     │   └── users
  │     │     ├── formatter_req.go    # Default request format for spesific controllers
  │     │     ├── formatter_res.go    # Default response format for spesific controllers
  │     │     ├── users_test.go       # Unit tests for spesific controllers
  │     │     └── users.go            # Spesific controller
  │     ├──helpers
  │     │   └── helper.go           # Helper Function
  │     └──routes  
  │         └── routes.go           # Endpoints list
  ├── entities                
  │     └── users.go          # database model
  ├── repository              
  │     ├── interface.go      # Repository Interface for controllers
  │     ├── users_test.go     # Unit test for spesific repository
  │     └── users.go          # Spesific Repository
  ├── utils                 
  │     └── driver.go         # Database driver
  ├── .env                    # Individual working environment variables
  ├── .gitignore              # Which files to ignore when committing
  ├── go.mod                  
  ├── go.sum                  
  ├── main.go                 # Main Program
  └── README.md    

(back to top)

Unit Test

Unit Test coverage above 99.5%

(back to top)

Contact

• Andrew Prasetyo (Person In Charge and maintainer)
  • LinkedIn
• Herlianto (Developer and maintainer)
  • LinkedIn
• Ilham Junius (Developer and maintainer)
  • LinkedIn

(back to top)