Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mlg404/proffy
Proffy is your online study platform where you can search fot teachers by classes or, if you are a teacher, you can register your classes!
https://github.com/mlg404/proffy
Last synced: 21 days ago
JSON representation
Proffy is your online study platform where you can search fot teachers by classes or, if you are a teacher, you can register your classes!
- Host: GitHub
- URL: https://github.com/mlg404/proffy
- Owner: mlg404
- License: mit
- Created: 2020-08-04T22:44:22.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-01-26T22:33:02.000Z (almost 2 years ago)
- Last Synced: 2024-10-28T15:30:35.391Z (3 months ago)
- Language: TypeScript
- Homepage:
- Size: 20.4 MB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 46
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Proffy: Next Level Week #2
Proffy is your online study platform where you can search fot teachers by classes or, if you are a teacher, you can register your classes!
Info |
Technologies |
How to |
Functionalities |
Contribute |
License
## :rocket: Info
This is a React, React Native and NodeJS application.
## :computer: Technologies
This project was developed following this technologies:
### General
- [VS Code][vc]
- [TypeScript](https://www.typescriptlang.org/)
- [axios](https://github.com/axios/axios)
### Mobile
- [Expo](https://expo.io/)
- [React Native](https://facebook.github.io/react-native/)
- [expo-google-fonts](https://github.com/expo/google-fonts)
- [async-storage](https://github.com/react-native-community/async-storage)
- [RN Gesture Handler](https://github.com/software-mansion/react-native-gesture-handler)
- [React Navigation](https://reactnavigation.org/)
### Web
- [React](https://reactjs.org)
- [React Router Dom](https://github.com/ReactTraining/react-router)
### Server
- [CORS](https://github.com/expressjs/cors)
- [Express](https://github.com/expressjs/express)
- [Knex](http://knexjs.org/)
## :information_source: How To
To clone this application you will need [Git](https://git-scm.com) + [Yarn v1.22.4](https://classic.yarnpkg.com/lang/en/) or higher + [Expo CLI][expocli] installed in your computer. Run in terminal:
```bash
# Clone this repo
$ git clone https://github.com/mlg404/proffy.git proffy
# Access this repo
$ cd proffy
# Install dependencies from web/server/mobile
# Repeat this proccess in the three folders
$ cd FOLDER
$ yarn install
# Run the application
$ yarn start
```
## :mag_right: Funcionalities
### Mobile
- Find "Proffys" to teach you
- Use filters to search "Proffys"
- Favorites the "Proffys" you want
- Create connections with "Proffys" and pupils
### Web
- Find "Proffys" to teach you
- Use filters to search "Proffys"
- Favorites the "Proffys" you want
- Register you as a "Proffy"
- Create connections with "Proffys" and pupils
- Send whatsapp message to your choosen "proffy"
## :busts_in_silhouette: Contribute
- Fork this repository;
- Create one branch with your feature: `git checkout -b my-feature`;
- Commit your alterations: `git commit -m 'feat: My new feature'`;
- Push to your branch: `git push origin my-feature`.
Open a pull request with your branch. After yout pull request merge, you should delete your branch.
## :memo: License
This project is under MIT license. See [LICENSE](https://github.com/mlg404/proffy/blob/master/LICENSE) for more information.
---
Made with 💙 by Victor Eyer :wave: [Get in touch!](https://www.linkedin.com/in/victoreyer/)
[nodejs]: https://nodejs.org/
[vc]: https://code.visualstudio.com/
[expocli]: https://expo.io/tools