Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rafacdomin/proffy
React Native + ReactJS + NodeJS project developed on RocketSeat NexLevelWeek. This project is based on an application for connect students and teachers.
https://github.com/rafacdomin/proffy
axios connect-students expo express nextlevelweek nlw node-js nodejs proffy proffy-server proffy-web react react-native react-navigation reactjs rocketseat styled-components teachers typescript
Last synced: 3 months ago
JSON representation
React Native + ReactJS + NodeJS project developed on RocketSeat NexLevelWeek. This project is based on an application for connect students and teachers.
- Host: GitHub
- URL: https://github.com/rafacdomin/proffy
- Owner: rafacdomin
- License: mit
- Created: 2020-08-04T00:29:44.000Z (over 4 years ago)
- Default Branch: v2
- Last Pushed: 2020-08-27T18:28:00.000Z (over 4 years ago)
- Last Synced: 2024-09-30T18:22:02.327Z (4 months ago)
- Topics: axios, connect-students, expo, express, nextlevelweek, nlw, node-js, nodejs, proffy, proffy-server, proffy-web, react, react-native, react-navigation, reactjs, rocketseat, styled-components, teachers, typescript
- Language: TypeScript
- Homepage:
- Size: 38.3 MB
- Stars: 27
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
About |
Technologies |
How To Use |
License |
Author
## About
React Native + ReactJS + NodeJS project developed on [RocketSeat NexLevelWeek](https://nextlevelweek.com/). This project is based on an application for connect students and teachers.
## Technologies
This project was developed with the following technologies:
- API:
- [NodeJS](https://nodejs.org/en/)
- [Typescript](https://www.typescriptlang.org/)
- [ts-node-dev](https://github.com/whitecolor/ts-node-dev)
- [Express](https://expressjs.com/)
- [KnexJS](http://knexjs.org/)
- [PostgreSQL](https://www.npmjs.com/package/sqlite3)
- [Cors](https://www.npmjs.com/package/cors)
- [bcrypt](https://www.npmjs.com/package/bcrypt)
- [JsonWebToken](https://www.npmjs.com/package/jsonwebtoken)
- Web:
- [ReactJS](https://reactjs.org/)
- [Typescript](https://www.typescriptlang.org/)
- [React Router v5](https://github.com/ReactTraining/react-router)
- [Axios](https://github.com/axios/axios)
- [styled-components](https://styled-components.com/)
- [Yup](https://www.npmjs.com/package/yup)
- [Unform](https://unform.dev/)
- Mobile:
- [React Native](https://reactnative.dev/)
- [Expo](https://expo.io/)
- [Typescript](https://www.typescriptlang.org/)
- [React Navigation v5](https://reactnavigation.org/)
- [styled-components](https://styled-components.com/)
- [Axios](https://github.com/axios/axios)
## How To Use
To clone and run this application, you'll need installed on your computer:
- [Git](https://git-scm.com)
- [Node.js](https://nodejs.org/)
- [Yarn v1](https://classic.yarnpkg.com/)
- [Expo](https://expo.io/) to run the Mobile app.
- One instance of [PostgreSQL](https://www.postgresql.org/) to run the server
> Obs.: I recommend using `docker` to create and run the PostgreSQL instance.
To run the server:
```bash
# Clone the server repository
$ git clone https://github.com/rafacdomin/proffy-api
# Create the instance of postgreSQL using docker
$ docker run --name proffyPG -e POSTGRES_USER=docker \
-e POSTGRES_DB=proffy -e POSTGRES_PASSWORD=docker \
-p 5432:5432 -d postgres
# Go into the repository folder
$ cd proffy-api
```
Make a copy of .env.example to .env and set YOUR enviroment variables
```bash
# Install dependencies
$ yarn
# Run the app
$ yarn dev
```
To run the frontend Web:
```bash
# Clone the Web repository
$ git clone https://github.com/rafacdomin/proffy-web
# Go into the web folder
$ cd proffy-web
```
Change the `baseURL` in `src/services/api.ts` to http://localhost:3333 or to where your server is running.
```bash
# Install dependencies
$ yarn
# Run the app
$ yarn start
```
Now access on your browser: http://localhost:3000
To run the mobile app:
```bash
# Go into the mobile folder
$ cd mobile
# Install dependencies
$ yarn
# Run the app
$ yarn start
```
Now your browser should open, and you just need to scan the QR Code to your phone.
## License
This project is under the MIT license. See the [LICENSE](https://github.com/rafacdomin/proffy/blob/master/LICENSE) for more information.
---
## Author
Made with :purple_heart: by Rafael Domingues :wave: [Get in touch!](https://www.linkedin.com/in/rafaelcodomingues/)
[](https://www.linkedin.com/in/rafaelcodomingues/)
[](mailto:[email protected])
[](https://dev.to/rafacdomin)
[](https://github.com/rafacdomin/?tab=follow)