BetterMaps
A new way to see the world !
📜 About
Welcome to BetterMaps! Here, within our expansive platform, you'll discover a multitude of new destinations awaiting your exploration. Whether you're seeking vibrant eateries, cozy cafes, exhilarating entertainment spots, tranquil retreats, or even productive workspaces, BetterMaps is your ultimate guide. But it doesn't end there - we encourage you to contribute your own favorite spots, enriching our community with hidden gems and beloved locales, all waiting to be shared with the world.
🚀 Technologies
Frontend
Backend
📦 Installation
Follow these steps to set up BetterMaps:
git clone https://github.com/parlabarbedeMerlin/Better-Maps.git cd Better-Maps📗 Documentation
Auth (/api/auth)
POST /api/auth/register
| Key | Description |
|---|---|
| The email of the user. | |
| firstName | The first name of the user. |
| lastName | The last name of the user. |
| password | The password of the user. |
| confirmPassword | The confirmation of the password (must be the same as the password). |
POST /api/auth/login
| Key | Description |
|---|---|
| The email of the user. | |
| password | The password of the user. |
POST /api/auth/verify
| Key | Description |
|---|---|
| verifyToken | The token of the user. |
Places (/api/places)
GET /api/places
| Query parameter | Description |
|---|---|
| skip | The number of places to skip. |
| limit | The number of places to return. |
| filters | The filters to apply to the places (JSON format). |
POST /api/places
The body must contain the place object following the Yup schema.
GET /api/places/:id
The ID is the ID of the place. The server will return the place object.
PATCH /api/places/:id
The body must contain the place object following the Yup schema. The ID is the ID of the place. The server will update the place object.
Project Structure
- src
- components → All the components of the application.
- forms → All the forms of the application.
- inputs → All the inputs of the application.
- nav → The navigation bar of the application.
- context → All the context of the application.
- utils → All the utilities of the application.
- auth → All the utilities for authentication.
- password → All the utilities for password management.
- controllers → All the controllers of the application.
- database → All the database utilities of the application.
- models → All the models of the application for the database.
- schemas → All the schemas of the application for the database.
- mail → All the utilities for email handling.
- schema → All the schemas of the application (Yup).
- pages → All the pages of the application.
- auth → All the utilities for authentication.
- components → All the components of the application.