Skip to content

Latest commit

 

History

History
61 lines (45 loc) · 2.55 KB

README.md

File metadata and controls

61 lines (45 loc) · 2.55 KB

Binary Studio Academy | 2021 | Java 1111

Mindbridge Deploy Mindbridge Prod

Staging Mindbridge Deploy Mindbridge Staging

Let us connect your minds

Mindbridge is a portal for sharing knowledge and thoughts (although you all have got different on the same topic) to allow dev-community communicate through articles, comments and likes (seems like I heard it somewhere 😃)

Technical side

Tech stack

  • Backend
    • Java 11 - core backend
    • Spring - core backend framework
    • Lombok - boiler-plate reducing annotation framework
    • Mapstruct - automapper to reduce mapping overhead
    • Hibernate - ORM for easy(but not simple) data access
    • Flyweight - migration tool
  • Database
    • Postgresql
  • Frontend
    • TypeScript (and JavaScript) - primary SPA implementation
    • React - SPA library
    • Redux - state management
    • Redux-toolkit - async interactions, effect management

Documentation

There is a submodule called docs which is for updating the postman collection and docs related to the project. To update it, please follow the next instructions:

# Time passes, submodule upstream is updated
# and you now want to update

# Change to the submodule directory 
# !from mindbridge root folder!
cd submodule_dir

# Checkout desired branch
git checkout master

# Update
git pull

# Get back to your project root
cd ..

# Now the submodules are in the state you want, so
git commit -am "Pulled down update to docs"

Deployment

The project is deployed to Azure Container Instances. Github actions are used for CI and CD.

Code quality

Static analyzers are used for both frontend and backend projects to ensure basic code quality. Additionally, quality criteria (and these one) rules are enforced during code review and audit.

License

Licensed under the MIT license.