README.md

LOMAP_ES1B1

Discover your city with LoMap - your personalized map, your way!
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Contact

📚 About The Project

The software development company HappySw has been hired by the Council of Brussels to develop a software system called LoMap.

This system will allow citizens to have personalized maps of places and local businesses in their city. The places that can be mapped include shops, bars, restaurants, sights, and cultural attractions, among others. Users will have full control over their personalized maps and the shared information will be stored in a personal pod according to the SOLID principles.

🚧 Built With

• Docker
• Node.js
• React.js
• MUI Core
• MongoDB
• TypeScript
• SOLID Pods
• Mongoose.js

(back to top)

🦶 Getting Started

📋 Prerequisites

If you already have Node.js and npm, ensure that you update them before trying to construct the images. To run the project, you'll need Node.js, Docker, npm and git installed on your machine. Make certain that all four are installed.

🛠 Installation

You can obtain the project by using the command git clone https://github.com/Arquisoft/lomap_es1b1.

With Docker

The most efficient method to initiate everything is by using Docker:

docker-compose up --build

Two docker images will be generated for the webapp and the restapi since they are not currently present on your system.

Without Docker

Compile and run the restapi:

cd restapi
npm install
npm start

Now the webapp:

cd webapp
npm install
npm start

You should be able to access the application in http://localhost:3000.

(back to top)

📮 Contact

Joaquín Hermida Giganto - Jhergig

Óscar Davila Sampedro - OscarDavilaSampedro

(back to top)