Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/solrachix/proffy
🚀 Project made to connect teachers to students, made in Next Level Week #2 #NLW @Rocketseat
https://github.com/solrachix/proffy
nle nlw-2 proffy rocketseat
Last synced: 3 months ago
JSON representation
🚀 Project made to connect teachers to students, made in Next Level Week #2 #NLW @Rocketseat
- Host: GitHub
- URL: https://github.com/solrachix/proffy
- Owner: solrachix
- Created: 2020-08-04T05:35:27.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-07-21T05:29:00.000Z (over 2 years ago)
- Last Synced: 2024-05-28T23:43:15.889Z (8 months ago)
- Topics: nle, nlw-2, proffy, rocketseat
- Language: TypeScript
- Homepage:
- Size: 72.4 MB
- Stars: 11
- Watchers: 3
- Forks: 2
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
> :rocket: Project made to connect teachers to students, made in Next Level Week #2 @Rocketseat
# :pushpin: Table of Contents
- [:pushpin: Table of Contents](#pushpin-table-of-contents)
- [:computer: Technologies](#computer-technologies)
- [:rocket: Features](#rocket-features)
- [:construction_worker: How to run](#construction_worker-how-to-run)
- [📦 Run API](#-run-api)
- [💻 Run Web Project](#-run-web-project)
- [📱 Run Mobile Project](#-run-mobile-project)
- [:bug: Issues](#bug-issues)
- [:tada: Contributing](#tada-contributing)
- [:closed_book: License](#closed_book-license)
* [License](#closed_book-license)
📥 Layout available for download at:
# :computer: Technologies
This project was made using the follow technologies:
* [Expo](https://expo.io/)
* [Express](https://expressjs.com/)
* [Typescript](https://www.typescriptlang.org/)
* [React](https://reactjs.org/)
* [Styled Components](https://styled-components.com/)
# :rocket: Features
* Website to sign up teachers and students.
* App to connect teachers and students.
# :construction_worker: How to run
```bash
# Clone Repository
$ git clone https://github.com/solrachix/Proffy.git
```
### 📦 Run API
```bash
# Go to server folder
$ cd Proffy/packagers/server
# Install Dependencies
$ yarn install
# Run Aplication
$ yarn start
```
Access API at http://localhost:3333/
### 💻 Run Web Project
```bash
# Go to web folder
$ cd Proffy/packagers/web
# Install Dependencies
$ yarn install
# 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](https://play.google.com/store/apps/details?id=host.exp.exponent) 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:
```bash
# 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](https://play.google.com/store/apps/details?id=host.exp.exponent) or run on emulator.
# :bug: Issues
Feel free to **file a new issue** with a respective title and description on the the [Proffy](https://github.com/sorachix/Proffy/issues) repository. If you already found a solution to your problem, **i would love to review your pull request**!
# :tada: Contributing
Check out the [contributing](./CONTRIBUTING.md) page to see the best places to file issues, start discussions and begin contributing.
# :closed_book: License
Released in 2020 :closed_book: License
Made with love by [Carlos Miguel](https://github.com/solrachix) 🚀.
This project is under the [MIT license](./LICENSE).
Give a ⭐️ if this project helped you!