Proffy 2.0

Table of Contents

• About
• Getting Started
• Goals
• Contributing

About

Proffy is a platform to bring together teachers and students. Built during Next Level Week # 2 promoted by @Rocketseat between August 3 and 9, 2020.

Getting Started

Install the Prerequesites then

# Clone Repository
$ git clone git@github.com:ItaloCosta99/Proffy-2.0.git

Prerequisites

This project was made using the follow technologies:

• Typescript
• React
• Expo
• Express

Installing

📦 Run API

# Go to server folder
$ cd Proffy/server

# Install Dependencies
$ yarn install

# Run Aplication
$ yarn start

Access API at http://localhost:3333/

💻 Run Web Project

# Go to web folder
$ cd Proffy/web

# Install Dependencies
$ yarn install

# Run Aplication
$ yarn start

Go to http://localhost:3000/ to see the result.

📱 Run Mobile Project

To run the mobile project you need a cellphone with the app of expo instaled or a emulator android/ios.
After, fork this repository and clone to your machine. Inside of the project's folder run the following commands:

# Go to mobile folder
$ cd Proffy/mobile

# Install Dependencies
$ yarn install

# Run Aplication
$ yarn start

Aferter read the QRCode with the app of expo or run on emulator.

Version 1.0

Web Screenshot

Mobile Screenshot

Goals

Version 2.0

Achieve the 2.0 version, .fig files for visualization on Figma available at the .github folder, just download and import on the website.

This project is under the MIT license.