Skip to content

πŸš€ Project made to connect teachers to students, made in Next Level Week #2 #NLW @Rocketseat

Notifications You must be signed in to change notification settings

solrachix/Proffy

Repository files navigation

Proffy

Carlos Miguel Repository size
GitHub last commit License
Stargazers

πŸš€ Project made to connect teachers to students, made in Next Level Week #2 @Rocketseat

The NLW #2 project. Built with ❀︎ by Carlos Miguel and contributors

πŸ“Œ Table of Contents

πŸ“₯ Layout available for download at:

Direct Download

πŸ’» 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/solrachix/Proffy.git

πŸ“¦ Run API

# Go to server folder
$ cd Proffy/packagers/server

# Install Dependencies
$ yarn install

# Run Aplication
$ yarn start

Access API at https://localhost:3333/

πŸ’» Run Web Project

# Go to web folder
$ cd Proffy/packagers/web

# Install Dependencies
$ yarn install

# Run Aplication
$ yarn start

Go to https://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/packagers/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 Carlos Miguel πŸš€. This project is under the MIT license.

Give a ⭐️ if this project helped you!

About

πŸš€ Project made to connect teachers to students, made in Next Level Week #2 #NLW @Rocketseat

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages