Giter VIP home page Giter VIP logo

proffy's Introduction

Proffy

Lorison Gilles Repository size GitHub last commit License Stargazers

🚀 Project made to connect teachers to students, made in Next Level Week #2 @Rocketseat

English · Portuguese

The NLW #2 project. Built with ❤︎ by Lorison Gilles and contributors

📌 Table of Contents

📥 Layout available for download at:

Direct Download Direct Download

Web Screenshot

Mobile Screenshot

👀 Demo Website

You can acess the website at:
👉 demo: https://www.youtube.com/watch?v=ptABXX-Amm4

Netlify Status

💻 Technologies

This project was made using the follow technologies:

🚀 Features

  • Website to sign up teachers and students.
  • App to connect teachers and students.

👷 How to run

# Clone Repository
$ git clone https://github.com/Gilles30/Proffy.git

📦 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

# If there is an error, in "react-dom", perform the installation below
$ yarn add @types/react-router-dom -D
$ yarn add axios

# 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.

🐛 Issues

Feel free to file a new issue with a respective title and description on the the Proffy repository. If you already found a solution to your problem, i would love to review your pull request!

🎉 Contributing

Check out the contributing page to see the best places to file issues, start discussions and begin contributing.

📕 License

Released in 2020 📕 License

Made with love by Lorison Gilles 🚀. This project is under the MIT license.

Give a ⭐️ if this project helped you!

proffy's People

Contributors

gill3s0x01 avatar

Stargazers

Gilles256 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.