README.md

👨🏽‍🏫 Proffy

👨🏽‍🏫 A marketplace for online study that connects professors with students

🛠️ Technologies

• TypeScript
• Node.js
• Express
• React
• React Native
• Expo
• SQLite
• Knex.js

⚙️ Requirements

• Git
• Node.js
• NPM
• Expo App
• Expo CLI

🚀 Installation

$ git clone https://github.com/gabrielsanttana/proffy

📦 API

$ cd proffy/backend
$ yarn
$ yarn run knex:migrate
$ yarn dev:server

The API will start serving on http://localhost:3333

Note: It's important to have the API running to be able to properly run the web and mobile app

💻 Web

$ cd proffy/frontend
$ yarn
$ yarn start

The application will pop-up in the browser on http://localhost:3000

📱 Mobile

It's also necessary to have a React Native Expo environment setup and the Expo mobile app installed on your smartphone. It's important that both the smartphone and the computer are connected to the same network and to have the local IP address on the baseURL in the api.ts file.

Example:

const api = axios.create({
  baseURL: 'http://000.000.00.000:3333',
});

Then:

$ yarn add -g expo-cli
$ cd proffy/mobile
$ yarn
$ expo install
$ yarn start

A new window with the application log will open in the browser

Then, you can simply load the app by scanning the QR code with the Expo mobile app or by using the local URL

⚖️ License

MIT License

Made with ❤️ by Gabriel Santana