https://github.com/jardelgcunha/proffy-web-mobile
Project Proffy: Next Level Week (NLW) for Rockseat ๐
https://github.com/jardelgcunha/proffy-web-mobile
api css html nodejs react-native reactjs typescript
Last synced: over 1 year ago
JSON representation
Project Proffy: Next Level Week (NLW) for Rockseat ๐
- Host: GitHub
- URL: https://github.com/jardelgcunha/proffy-web-mobile
- Owner: jardelgcunha
- License: mit
- Created: 2020-08-04T05:43:36.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-26T22:35:52.000Z (over 3 years ago)
- Last Synced: 2025-01-15T01:07:35.867Z (over 1 year ago)
- Topics: api, css, html, nodejs, react-native, reactjs, typescript
- Language: TypeScript
- Homepage:
- Size: 3.37 MB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 45
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Proffy (Web and Mobile)
> :computer: Made to connect teachers to students, made in Next Level Week #2 [Rocketseat](https://rocketseat.com.br/)
## ๐ Stacks
This project was developed with the following technologies:
- [Node.js](https://nodejs.org/en/)
- [React](https://reactjs.org)
- [React Native](https://reactnative.dev/)
- [TypeScript](https://www.typescriptlang.org/docs)
- [Knex.js](http://knexjs.org/)
- [Express.js](https://expressjs.com/pt-br/guide/routing.html)
- [Expo](https://expo.io/)
- [SQLite](https://www.sqlite.org/docs.html)
Tools & Utilities included:
- [Insomnia Core (API)](https://support.insomnia.rest/)
- [JSX](https://jsx.github.io/doc.html)
- [Prettier](https://prettier.io/docs/en/index.html)
- [ESLint](https://eslint.org/docs/user-guide/getting-started)
- [Expo Google Fonts](https://github.com/expo/google-fonts)
## :up: App Features
- Each teacher creates a class and makes his availability available;
- Favorite classes (only mobile);
- List classes for subject, day of week and time;
- Create a new connection every time the student contacts the teacher via Whatsapp;
- List all connections on the landing page.
# :construction_worker: How to run?
```bash
git clone https://github.com/JardelDeveloper/proffy-nlw-rocketseat.git
```
# :incoming_envelope: Run API (Backend)
```bash
# Access the directory
$ cd proffy-nlw-rocketseat/server
# Install Dependencies
$ yarn install
# Run Apแนlication
$ yarn start
```
Once [Insomnia](https://insomnia.rest/download/core/?&ref=https%3A%2F%2Fwww.google.com%2F) is installed, you can make the API requests using the get and post method, and see the results instantly.
Go to http://localhost:3333/ to see the API application's response.
# :computer: Run Web App (Frontend)
```bash
# Access the directory
$ cd proffy-nlw-rocketseat/web
# Install Dependencies
$ yarn install
# Run Aplication
$ yarn start
```
Go to http://localhost:3000/ to see the web application's response.
# :iphone: Run Mobile App
```bash
# Install expo-cli globally
$ yarn global add expo-cli
# Create the mobile project
$ expo init mobile
# Access the directory
$ cd mobile
# Run application
$ expo start
```
After accessing the QR Code, you will see the answer on your cell phone or it will run in the emulator.
# ๐ค How to contribute?
```bash
# Make a Fork this repository;
# Create a branch with your feature:
git checkout -b my-feature;
# Make commit to your changes:
git commit -m "feat: my new feature";
# Make a push to your branch:
git push origin my-feature;
```
After the merge of your pull request is done, you can delete a branch of yours.
# :wrench: Issues
Feel free to **file a new issue** with a respective title and description on the [Proffy](https://github.com/JardelDeveloper/proffy-nlw-rocketseat/issues) repository. If you already found a solution to your problem, **I would love to review your pull request**.
# :memo: License
Released in 2020 :closed_book:
This project is under the MIT license. See the [LICENSE](https://github.com/JardelDeveloper/proffy-web-mobile/blob/master/LICENSE) for more details.
Made with :green_heart: by Jardel Cunha.
Give :star: if this project helped you!