Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/guilhermeorcezi/proffy
🚀 Proffy: Project developed during the 2nd edition of Rocketseat's NLW.
https://github.com/guilhermeorcezi/proffy
nodejs react react-native reactjs
Last synced: about 4 hours ago
JSON representation
🚀 Proffy: Project developed during the 2nd edition of Rocketseat's NLW.
- Host: GitHub
- URL: https://github.com/guilhermeorcezi/proffy
- Owner: guilhermeorcezi
- Created: 2020-08-03T15:18:14.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-01-26T22:31:52.000Z (almost 2 years ago)
- Last Synced: 2023-03-07T16:05:57.251Z (over 1 year ago)
- Topics: nodejs, react, react-native, reactjs
- Language: TypeScript
- Homepage:
- Size: 3.94 MB
- Stars: 2
- Watchers: 1
- Forks: 2
- Open Issues: 46
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
🚀 Proffy Project developed during the 2nd edition of Rocketseat's NLW.
# :pushpin: Table of Contents
- [About](#sobre)
- [Technologies](#tecnologias-utilizadas)
- [How to run](#como-usar)
- [How to Contribute](#como-contribuir)
## :bookmark: About
The Proffy is a project made to connect teachers to students.
## :rocket: Technologies
The project was developed using the following technologies
- [TypeScript](https://www.typescriptlang.org/)
- [Knex](http://knexjs.org/)
- [Node.js](https://nodejs.org/en/)
- [ReactJS](https://reactjs.org/)
- [React Native](https://reactnative.dev/)
- [Expo](https://expo.io/)
### Web Screenshot
### Mobile Screenshot
## :fire: How to run
### :exclamation: Back-End (API server)
Clone the project on your computer. To install the dependencies and run the **Server** (development mode) execute:
```bash
cd server
yarn install // npm install
yarn dev // npm dev
```
### :exclamation: Front-End (Web Application)
To start ** Frontend ** of React use the commands:
```bash
cd web
yarn install // npm install
yarn start // npm start
```
After the process is over, the `localhost: 3000` page containing the developed project will automatically open in your browser.
### :exclamation: Mobile
To look the mobile application with React Native, first you need to put the server's IP (or computer's IP) in the `src/services/api.js file` and then execute the commands:
``` bash
# It is NOT necessary to execute a bottom line if you already have Expo (CLI) installed
global yarn add install expo-cli // npm install -g expo-cli
cd mobile
yarn install // npm installation
yarn start // npm start
```
### :recycle: How to contribute
- First, leave a ⭐ if you like it!
- Fork this repository;
- Create a branch with your feature: `git checkout -b my-feature`
- Commit your changes: `git commit -m 'feat: My new feature'`
- Push your branch: `git push origin my-feature`
## :memo: License
This project is under the MIT license. See the [licence page](https://opensource.org/licenses/MIT) for more details.
---
Made with 💜 by Guilherme Orcezi