---

NLW    |    FUNCTIONALITIES    |    INSTALATION    |     LAYOUT

---

🚀 NLW

NLW (next-level-week) is an intensive week managed by RocketSeat

This week's project was Happy, a project focused on orphanages, with the goal of bringing more people closer to the nearest orphanages

---

⚙ Functionalities

• Map showing all registered orphanages and their location.

• Register orphanage showing on the map in your location.

• Page showing details of the orphanage (name, about, available time, whatsapp contact ...).

✅ Features added by me.

• Switch Theme ( dark - light).

• Switch Theme in map ( dark - light - satelite).

• Added success page after registering an orphanage.

✅ Future updates.

• Add whatsapp field.

• Add colors in the respective markers (when registering an orphanage, the author chooses the color).

• DashBoard User(Admin).

• Delete Orphanage (Dashboard).

• Authenticated routes - web/back (Dashboard).

• Custom Alerts depending on the status of routes (Web).

• Change password if lost (Dashboard).

---

🔥 Instalation

First Clone this repositiory

$ git clone https://github.com/Matheus0liveira/next-level-week-3.git

BackEnd

Create a variable file at the root of your project and place the settings for: JWT_TOKEN, and the mailtrap settings:

Example:

For instalaitons dependncies execute: (using yarn/npm):

$ cd backend/


# yarn

$ yarn   #or yarn install


# npm

$ npm i  #or npm install

To execute the migrations run the following command:

# yarn

$ yarn typeorm migration:run


# npm

$ npm run typeorm migration:run

To delete migrations run the following command:

# yarn

# Erases the last migration made
# To delete both run twice or delete the tables directly from your sgbd

$ yarn typeorm migration:revert


# npm

$ npm run typeorm migration:revert

And finally... execute...

# yarn

$ yarn dev


# npm

$ npm run dev

Web and mobile

Apenas execute

$ cd web/
#or
$ cd mobile/

#For install dependencies

$ yarn

#or

$ npm i #or npm install

And finally...

#For execute front-end web

$ yarn start

#or

$ npm start

---

🖌 Layout

Layout in figma → Figma

---

Project created by: Matheus Oliveira 💜

---