Table of contents

• Prerequisites
• How to run the application
  • Backend setup
  • Frontend setup
  • Mobile setup
  • Start application
• Tecnologies
• Author

Prerequisites

Before starting, you're gonna need to have Docker (v19.03.0+) and Expo installed on your machine, and Expo installed on your smartphone. Besides that, a text editor like VSCode is recommended.

How to run the application

Backend setup

1. Create a file .env
2. Copy what is inside .env.example and paste in .env;
3. If necessary, change the fields (Probably you won't have to do this, just if you want to)
4. Open the terminal at the backend folder and type the command bellow to install the required packages:

   > yarn

5. Open the terminal at the backend folder and type the command bellow to build the backend's and the database's containers:

   > docker-compose up --build -d

6. Run all the migrations:

   > docker exec shieldchat_backend yarn typeorm migration:run

7. Watch the backend's logs:

   > docker logs -f shieldchat_backend

Frontend setup

1. Open the terminal at the frontend folder and type the command bellow to install the required packages:

   > yarn

Mobile setup

1. Open the terminal at the mobile folder and type the command bellow to install the required packages:

   > yarn

2. Create a file .env
3. Copy what is inside .env.example and paste in .env, and change the fields as necessary

Start application

1. To start the backend, you have to setup the containers first. Once they're configured, start the shieldchat_db container, then the shieldchat_backend:

   > docker start shieldchat_db

   > docker start shieldchat_backend

2. In frontend folder, type the command bellow:

   > yarn start

3. In mobile folder, type the command bellow:

   > yarn start

   If you want to change the fields in .env file after the first time, you have to start with the command bellow:

   > expo -c start

Tecnologies

• Node.js
• React
• React Native
• Expo
• TypeScript
• PostgreSQL
• Docker

Author

Made by Daniel Gustavo