Git Product home page Git Product logo

nano's Introduction

Nano

Goal

The main goal of this project is to create a reservation system that allows customers to reserve a service and providers to manage their services.

Engineering goals

Using DDD to design the domain model and event sourcing to handle the business logic. Experiencing with Clean Architecture which separating by domain folder structure.

Design Approach

For design reference, I utilized event storming to transform wireframes into logical diagrams, facilitating top-level design creation.

Analyzing requirements involved step-by-step wireframe design:

Example: Provider functionalities

  1. Creating wireframes and user flows with input from designers. provider-design-draft.png

  2. Employing event storming to visually represent the diagram, making requirements clear for system design. provider-event-sourcing.png

Utilizing the diagrams to design the database schema, thereby integrating all diagrams to provide an overview of domain separation.

  • DB Schema db-schema.png
  • Domain Separation domain-provider.png domain-service.png domain-order.png

Features (Not all features are implemented)

Provider can:

  • Create a new service
  • Update a service
  • Delete a service
  • View all services
  • View all orders
  • View all orders for a specific service

Provider

Customer can:

  • View all services
  • Request order a service
  • View all orders
  • Get notified when the order with icalendar.

Customer

Tech Stack

  • Monorepo: Nx
  • Frontend: React, Unocss, Vite, Jest
  • Backend: Express, TypeORM, MySQL, Docker, Jest

Environment Setup

  1. setup environment note: Fill in the .env file with your own credentials

      yarn 
      cp services/backend/.env.example services/backend/.env
  2. run backend service note: Don't forget to setup your docker environment

      nx dev backend
  3. run frontend service

      nx dev frontend
  4. on your nginx to proxy the port 81 for backend and frontend service

      brew services start nginx
      nginx -c nginx.conf

nano's People

Contributors

achinchen avatar dependabot[bot] avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.