Git Product home page Git Product logo

proffy's Introduction

Proffy Logo

Proffy ๐Ÿ‘จ๐Ÿฝโ€๐Ÿซ

Study when and where you wish. Proffy is a software developed to connect students and teachers all over the world ๐ŸŒ

Technologies

Back-End ๐Ÿ’ป

  • Express.js
  • Typescript
  • Knex
  • SQLite3
  • Yarn

Web โš›๏ธ

  • ReactJS
  • Typescript
  • Axios
  • React Hooks
  • CSS ๐Ÿ’…๐Ÿฝ
  • Yarn

Mobile ๐Ÿ“ฑ

  • React Native
  • React Hooks
  • Expo CLI
  • Axios
  • Yarn

How-To ๐Ÿ“š

Running this application is really simple. First of all you need to clone this repository to you workstation: https://github.com/eduardo3g/proffy.git

You're also supposed to have NPM or Yarn installed on your machine, Expo CLI and Expo Client app in your cellphone.

  • NPM or Yarn - Both of them are package managers. They will be used to get all the required dependencies this project needs to run. Choose one of your preference.
  • Expo CLI - The mobile project developed with React Native depends on Expo, so go check their documentation and follow the installation steps.
  • Visual Studio Code (IDE) - Download VS Code as your IDE or choose one that you enjoy the most ๐Ÿš€

Once you have completed all the previous installation steps, it's time to run our application! Let's beggin starting the backend.

In the root directory we have three folders: server, web and mobile. Move yourself inside each of them and run two commands:

  • yarn install: get all the dependencies
  • yarn start: run the project

When you run the commands above inside the mobile directory, a new window will be opened in your default browser.

After scanning the QRCode in your screen the Expo Client app will be opened in your cellphone running the React Native application.

Just wait a few seconds to build then you're done โœ… Hope you enjoy it.

Preview

Web ๐Ÿ–ฅ๏ธ

Landing page preview Teachers list page preview Give classses page first preview Give classses page second preview

Mobile ๐Ÿ“ฑ

Landing page mobile preview Teachers list page mobile preview

Thank you! ๐Ÿ™‹๐Ÿฝ

Made with love by @eduardo3g. Hope you appreciate it ๐Ÿ”ฅ

proffy's People

Contributors

eduardo3g avatar dependabot[bot] avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.