Skip to content

Latest commit

 

History

History
122 lines (90 loc) · 2.82 KB

README.md

File metadata and controls

122 lines (90 loc) · 2.82 KB

Proffy Web

Full stack project with mobile, web and API. A plataform that connects inependent teachers and students. Project initially developed at Next Level Week #2 from @Rocketseat.

The complete project is constituted by these three repositories:

Current Project State: 🛠️ Working 🛠️

Features list (also todo-list)

  • Landing page
  • Show total connections
  • Study Page
  • Teacher list Page
  • Filter teachers classes
  • Show filtered teachers classes
  • Give-Classes Page
  • Teacher can register a class
  • Show all the classes by pagination
  • Dinamically filter classes
  • Login
  • Register
  • Favorites Page
  • Show Favorited teachers
  • User can add teachers to favorites
  • User can remove teachers from favorites
  • User profile Page

Preview: web application

Dependencies (Pre-requisites)

Before try 🔬 proffy-web from your own local network you must have installed the following dependencies:

Test the dependencies

Into your terminal run:

Node

node --version

Output expected:
v12.8.3

Yarn

yarn --version

Output expected:
v1.22.4

Git

git --version

Output expected:
git version 2.25.1

The versions can vary, if they vary too much and some bug occur, unninstall the current version and install the exact version of outputs above.

Set up the API

Clone this repository, into your terminal run:

git clone https://github.com/Kochiyama/proffy-web

Then change the actual directory to the proffy-web folder, run:

cd proffy-api

Install all the packages automatically, just run:

yarn

Set-up API address:

⚠️ before proceding you must set up the Api follow the instructions into the link above

with your 'API address' in hands, open the api.ts file on your text editor (my recomendation: vscode). It is located at proffy-web/src/services
Then replace the Base_url string to your api address:

And finally:

yarn start

it will automatically open proffy on web running at your local machine

✒️ Feedback

If you found a bug or error feel free to create a new issue on this repository
Any feeedbacks and opinions are welcome, send me a e-mail: [email protected]