Ignema / Bricoly

A platform that links service providers with clients using Angular & Springboot

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Bricoly : Engineer Your Life The Way It Should Be...

πŸ“˜ Description

This project's aims to connect people who are able to grant services with clients who may need them. This was done in the context of our federator project in Ensias. You can check the report here.

πŸ” Instructions

The first thing we need to do is clone the repository and get the code:

git clone https://github.com/Ignema/Bricoly.git

πŸ“Œ Running the code locally from source

There are four things that we need to execute the whole application.

  • Postgres Database (Make sure you edit application.properties with the right credentials so that the backend can detect your database)

  • JDK 17 ⚠️ (An IDE like intellij or eclipse will do the work automatically for you)

      # Windows
      gradlew bootRun
      # Linux
      ./gradlew bootRun
    
  • Node

      npm install
    
  • Angular-CLI

      npm install -g @angular/cli 
      ng serve --open
    

πŸ“Œ Running the project with containers

If you want to run the containers seperately then you can pull them independently from docker hub like so

# Frontend
docker pull ignema/bricoly-frontend

# Backend
docker pull ignema/bricoly-backend

# Don't forget to run a postgres container as well!!!

If you want to run the cluster at once, you can simply run this command (Recommended)

docker-compose -p bricoly up

πŸ“Œ Running the project with kubernetes

If kubernetes is more up your alley you can use the k8s config to deploy the cluster

kubectl apply -f k8s/deployments

kubectl apply -f k8s/services

watch -n 0.5 kubectl get all

πŸ“… Database Schema

🎨 Mockup Design

The initial designs were made with Figma. You can check them here.

βš™οΈ App Overview

πŸ“ƒ Landing Page

By the way, here's the original pictures used in the landing page's carousel:

πŸ“ƒ About Page

πŸ“ƒ Login Page

πŸ“ƒ Register Page

πŸ“ƒ Catalog Page

πŸ“ƒ Offer Detail Page

πŸ“ƒ Provider Profile Page

πŸ“ƒ Dashboard Section

πŸ—žοΈ Dashboard Profile Edit Page

πŸ—žοΈ Dashboard Offer History

πŸ—žοΈ Dashboard Add Offer Modal

πŸ—žοΈ Dashboard Job Feed

πŸ“ƒ Swagger UI of Backend API

Made with πŸ’™ by Ignema

About

A platform that links service providers with clients using Angular & Springboot

License:MIT License


Languages

Language:Java 56.1%Language:TypeScript 19.0%Language:CSS 14.2%Language:HTML 9.7%Language:JavaScript 0.8%Language:Dockerfile 0.2%