ViniciusResende / RIVPR

An application visioning a better administration for local governmental entities in their cities.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

RIVPR

๐ŸŒŽ An application visioning a better administration for local governmental entities in their cities. ๐ŸŒŽ

๐ŸŒ RIVPR(Regional Issue Vizualizer and Problemns Report) | | In Development ๐ŸŒ

About   |    Layout   |    Lauching the project   |    Technologies   |    Author



๐Ÿ“ฑ About the project:

๐ŸŒŽ RIVPR - Is an application that allows the users report problems in their region, so the governmental entities will be able to see easier the problems with the city and solve them quickly.

๐ŸŽ“ The project was developed with the main purpose of became the undergraduate thesis in the technician course of IT from the Federal University of Viรงosa.

๐Ÿ“ˆThe project was an essential opportunity to develop skills with React Native, NodeJS and others technologies, like the Geocoding API's and Maps libraries.

๐Ÿ”Ž More informations:

This repository contains an REST API developed with NodeJs as backend and a mobile application developed in React Native, every of them in JavaScript.

Node.js: is an REST API that does all the CRUD of the application, data persistence, exception management and gives data to the mobile part of the project.

React Native: is the app part that contains the User Interface, and also has the map display with some functions that are essential for the well working.



๐ŸŽจ Layout of the Application:

LogIn and SignUp Screens:

RIVPR-LoginAndSignUp

Main Screen:

RIVPR-MainScreen

Report Inspect Screen:

RIVPR-ReportInspect

Profile and Profile Options Screens:

RIVPR-ProfileAndProfileOptions

Add Report and Seach Report Screens:

RIVPR-AddReportAndReportSearch



๐Ÿš€ Launching the project:

The project is divided in two main parts:

  1. Backend (backend folder)
  2. Mobile/Frontend (mobile folder)

๐Ÿ’ก Is required that the backend is in execution to work.

Pre requirements

Before start, you should need have installed in your computer those following tools:

GIT Git
NodeJS Node.js

Adding, you must have an ambient to run mobile applications, you can choose the Expo for that:

Expo Expo

It is also recommended a good code editor, for example:

VisualStudioCode VSCode

Ending, is necessary to have an SQL database, preferentially:

SQLite3 SQLite3


โš™๏ธ Starting the Backend (Server API):

# Clone the Repository
$ git clone https://github.com/ViniciusResende/RIVPR.git

# Enter the poject folder in the Terminal
$ cd RIVPR

# Go to the server folder
$ cd backend

# Install all the dependencies
$ npm install

# Execute the following code to construct the migrations
$ npx knex migrate:latest

# Execute the appliction with this command
$ npm start

# The server will start in the port:3333

๐Ÿ“ณ Starting the Frontend (Mobile):

# Clone this Repository
$ git clone https://github.com/ViniciusResende/RIVPR.git

# Enter the poject folder in the Terminal
$ cd RIVPR

# Go to the mobile folder
$ cd mobile

# Install all the dependencies
$ npm install

# Execute the appliction with this command
$ yarn start

# With this done, a QR Code will be displayed, you can scan it with the Expo App or you can take the route link and use in a Cell Phone Emulator

๐Ÿ‘จโ€๐Ÿ’ป Used Technologies:

Those following tools were used in the project development:

Server (NodeJS + JavaScript)


๐Ÿ™‹โ€โ™‚๏ธ Author


Vinรญcius Alves

About

An application visioning a better administration for local governmental entities in their cities.


Languages

Language:JavaScript 100.0%