Git Product home page Git Product logo

ship-composer's Introduction

ship-composer

Design your custom ship, and order it online

Introduction

The project aims to demonstrate auth architectural skills through solving a simple problem of Business Entity CRUD actions

Notes:

Due to limiation of time, the implementation of architecture rules may differ from the documentation. However the documenation clarifies very well what would have been done if we were in production mode.

The server side is far from perfect, and adds some layers that may not really be unnecessary for the coding challenge purpose. However it can demonstrate a scalable architecture in case if it is applied for a real business app.

Worthless to mention that all that scaffold code could be generated using infrastructure as a code approach, but due to time limiation I wanted to show the final output of this base.

Screenshot

drawing

drawing

drawing

drawing

Server Side:

Divide & Conquer is an effective approach not only for solving real life problems, but also for solving technical porblems. The goal is to always break down your issues into granular level, so you can conquer(solve) them easily.

The server side architecture is following clean architecture rules which applies seperation of concern(Divide & Conquer paradigm)

The architecture was propsed by Uncle BoB and is followed by many Engineers, and is proven to be a successful model that can with many Business Cases, disregarding Business size, or Business category

The architecture is micro-service friendly, which assumes that each business entity API can be tested, built, and deployed separately without any coupling, or dependency of other entities, or services. However this architecture can still be used in a module based monolith API

API Gateway -> Validator -> Handler -> Controller -> UseCase -> Presenter

Client Side

The client side project is forked from previous templates that I used in side projects, and is inspired from the following project: https://github.com/akveo/ngx-admin

Even though not all features are used here (like Auth/Guards, Advanced Navigation .. etc), but it can be easily changed in future to enable these modules and make it functional with very little effort

Documentation

Each project has its own README.md file wich explains how to set the project up, and running

ship-composer's People

Contributors

justgeek avatar

Watchers

 avatar  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.