Project made to connect people to orphanages, inspired by Next Level Week #3 @Rocketseat

Web Screenshot

Mobile Screenshot

Technologies

This project was made using the follow technologies:

• NodeJS
• Typescript
• Express
• React
• React Native
• SQLite

---

API

The API was built with the following functionalities:

Orphanages

• Create orphanage;
• List orphanages;
• List orphanage by id;

NOTE: you can find a Postman Collection at the server/postman folder, with examples of all the requests.

---

How to run

1. Clone Repository

git clone https://github.com/mauroviniciussilva/happy.git

2. Run API

Setup .env file

Create a .env file in the /server folder and setup your IP Adress:

BASE_IP_ADRESS=<ip_adress>:3333

Go to server folder

cd server

Install dependencies

yarn

Run migrations

As the project is using SQLite, it is not necessary to do any previous database installation or configuration to run the project. You just need to run the migrations with the following command:

yarn typeorm migration:run

---

Run

yarn dev

NOTE: API will run at port 3333

3. Run WEB Project

Setup .env file

As I'm using mapbox you need to have the token to render the map. You can see how to create one in the official docs. After getting the token, you must create an .env file in the /web folder with the following syntax:

REACT_APP_MAPBOX_TOKEN=<mapbox_token>

Go to web folder

cd web

Install dependencies

yarn

Run application

yarn start

NOTE: WEB Application will run at port 3000

4. Run Mobile Project

To run the mobile project you need a phone with the expo app instaled or a emulator Android/iOS.

Setup .env file

Create a .env file in the /mobile folder and setup your IP Adress to access the backend:

BASE_URL=http://<ip_adress>:3333

Go to mobile folder

cd mobile

Install Dependencies

yarn

Run Aplication

yarn start

When you run it, the expo developer tools should open on a browse window.

You need to read the QRCode with expo app, or run on emulator to see the result.

---