From f6f7b5bba7271bce02d923af3e72c6cd66dbec30 Mon Sep 17 00:00:00 2001 From: Akram El Assas Date: Wed, 24 Apr 2024 13:43:19 +0100 Subject: [PATCH] Update README.md --- README.md | 12 ++---------- 1 file changed, 2 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index f9ab4603..4db28797 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,5 @@ [![build](https://github.com/aelassas/movinin/actions/workflows/build.yml/badge.svg)](https://github.com/aelassas/movinin/actions/workflows/build.yml) [![test](https://github.com/aelassas/movinin/actions/workflows/test.yml/badge.svg)](https://github.com/aelassas/movinin/actions/workflows/test.yml) [![codecov](https://codecov.io/gh/aelassas/movinin/graph/badge.svg?token=TXD8SM1QHB)](https://codecov.io/gh/aelassas/movinin) [![](https://img.shields.io/badge/docs-wiki-brightgreen)](https://github.com/aelassas/movinin/wiki) [![](https://img.shields.io/badge/live-demo-brightgreen)](https://github.com/aelassas/movinin?tab=readme-ov-file#live-demo) - - Movin' In is a Rental Property Management Platform with a backend for managing properties, customers and bookings, a frontend and a mobile app for renting properties. Movin' In is designed to work with multiple agencies. Agencies can manage their properties and bookings from the backend. Movin' In can also work with only one agency as well. @@ -15,13 +11,9 @@ When new agencies are created, they receive an email prompting them to create th Customers can sign up from the frontend or the mobile app, search for available properties based on location point and time, choose a property and complete the checkout process. A key design decision was made to use TypeScript instead of JavaScript due to its numerous advantages. TypeScript offers strong typing, tooling, and integration, resulting in high-quality, scalable, more readable and maintainable code that is easy to debug and test. - + Movin' In can run in a Docker container. Follow this step by step [guide](https://github.com/aelassas/movinin/wiki/Docker) to walk you through on how to build Movin' In Docker image and run it in a Docker container. - + ## Features * Agency management