🍣 Sushi Kame Booking

Specialty booking software for Omakase Restaurants

 

Getting Started

Clone the repository using git clone git@github.com:j-rockwell/kame.git

Start all applications using docker-compose up --build

If successful you will see the frontend running on localhost:3000, admin running on localhost:3001, backend services on localhost:8080 and mongo/redis on their default ports.
 

Project Contents

.github/workflows

When changes are pushed to the main branch, we run the following workflows:

• CodeQL Analysis on both the Client and Server
• Standard Go Build on the Server
• Standard npm run build on the Client
• Test Coverage for the Client

These tests insure that we are not pushing a failing build to production servers. In the future, additional integration tests will be performed via Docker images.

/client

Next.js application that consumes data from the /server. Styling is powered by Chakra and Framer Motion.

/admin

Next.js application that grants administrative capabilities from the /server. When running in debug mode an admin account will be generated with the login: admin:admin.

/server

Gin-gonic monorepo which powers all backend services. Main backing database is handled by MongoDB and quick cache r/w uses Redis

docker-compose.yml

Composes all docker instances needed to run the application locally. In production these images are all pushed separately.  

Disclaimer

This project is not for public/commercial-use outside of Sushi Kame. This application has been sanitized and made public as a portfolio item with the contract holders approval. For business/freelance inqueries you can send me an email.  

Copyright

Copyright 2023 John Rockwell Open-source under the MIT License