Giter VIP home page Giter VIP logo

proffy's Introduction

Proffy

โ” About

A study platform to connect students and teachers. The main idea is the teacher to register the classes and the student select a class to study.

๐Ÿ“ธ Screenshots

Interface Web

Landing Page Proffy in Desktop

๐Ÿ›  Techs

Proffy was built using the following:

โš™ How to Install and Start

To install and start proffy follow the steps below:

Installation

Clone the Repository:

git clone https://github.com/abnersouza/proffy.git

Start Node Server

Open the cloned repository na navigate to the web folder

cd ./proffy/server

Install the dependencies ๐Ÿš€

NPM
# Install all dependencies
> npm install

# Create a sqlite database and run the migrations
> npm run knex:migrate:latest

# Start the proffy web
> npm start
YARN
# Install all dependencies
> yarn install

# Start the proffy web
> yarn start

Start Web Version

Open the cloned repository na navigate to the web folder

cd ./proffy/web

Install the dependencies ๐Ÿš€

NPM Packages
# Install all dependencies
> npm install

# Start the proffy web
> npm start
YARN Packages
# Install all dependencies
> yarn install

# Start the proffy web
> yarn start

Start Mobile Version

Open the cloned repository na navigate to the web folder

cd ./proffy/mobile

Install the dependencies ๐Ÿš€

EXPO
EXPO Installation NPM or Yarn

# NPM
> npm install expo-cli --global

# Yarn
> yarn global add expo-cli
Expo Dependencies
# Expo Dependencies
> expo install react-native-gesture-handler react-native-reanimated react-native-screens react-native-safe-area-context @react-native-community/masked-view expo-font @expo-google-fonts/archivo @expo-google-fonts/poppins
NPM Packages
# Install all dependencies
> npm install

# Start the proffy mobile
> npm start
YARN Packages
# Install all dependencies
> yarn global add expo-cli

# Start the proffy mobile
> yarn start

๐Ÿฅ… Plans

  • Implement the classroom for one to one video call using WebRTC and Socket.io

๐Ÿ“œ License

This project is under MIT License MIT

Special Thanks

To all @Rocketseat team members for the amazing Next Level Week 2 course.

Made with โค๏ธ by Abner Souza

proffy's People

Contributors

abnersouza avatar

Watchers

 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.