https://github.com/xterikatx/proffy
👩🏫 Project made to connect teachers to students
https://github.com/xterikatx/proffy
connect-teachers css expo express node proffy react sqlite3 students typescript
Last synced: 28 days ago
JSON representation
👩🏫 Project made to connect teachers to students
- Host: GitHub
- URL: https://github.com/xterikatx/proffy
- Owner: xterikatx
- License: mit
- Created: 2020-08-07T01:23:19.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-05-17T01:56:42.000Z (almost 4 years ago)
- Last Synced: 2025-02-06T04:44:17.989Z (3 months ago)
- Topics: connect-teachers, css, expo, express, node, proffy, react, sqlite3, students, typescript
- Language: TypeScript
- Homepage:
- Size: 401 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
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
* [Technologies](#computer-technologies)
* [Features](#rocket-features)
* [How to Run](#construction_worker-how-to-run)
* [Found a bug? Missing a specific feature?](#bug-issues)
* [Contributing](#tada-contributing)
* [License](#closed_book-license)
### Web Screenshot
### Mobile Screenshot
# :computer: Technologies
This project was made using the follow technologies:
* [Typescript](https://www.typescriptlang.org/)
* [React](https://reactjs.org/)
* [Expo](https://expo.io/)
* [Express](https://expressjs.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/erikalopes/proffy.git
```
### 📦 Run API
```bash
# Go to server folder
$ cd proffy/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/web
# Install Dependencies
$ yarn install
# Run Aplication
$ yarn start
```
Go to http://localhost:3000/ to see the result.
# :bug: Issues
Feel free to **file a new issue** with a respective title and description on the the [Proffy](https://github.com/erikalopes/proffy/issues) repository. If you already found a solution to your problem, **i would love to review your pull request**!
# :closed_book: License
Released in 2020 :closed_book: License
Made with love by [Erika Lopes](https://github.com/erikalopes) 🚀.
This project is under the [MIT license](./LICENSE).
Give a ⭐️ if this project helped you!