proffy

About

React Native + ReactJS + NodeJS project developed on RocketSeat NexLevelWeek. This project is based on an application for connect students and teachers.

Technologies

This project was developed with the following technologies:

• API:

  • NodeJS
  • Typescript
  • ts-node-dev
  • Express
  • KnexJS
  • PostgreSQL
  • Cors
  • bcrypt
  • JsonWebToken

• Web:

  • ReactJS
  • Typescript
  • React Router v5
  • Axios
  • styled-components
  • Yup
  • Unform

• Mobile:

  • React Native
  • Expo
  • Typescript
  • React Navigation v5
  • styled-components
  • Axios

How To Use

To clone and run this application, you'll need installed on your computer:

• Git
• Node.js
• Yarn v1
• Expo to run the Mobile app.
• One instance of PostgreSQL to run the server

Obs.: I recommend using docker to create and run the PostgreSQL instance.

To run the server:

# 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

# Install dependencies
$ yarn

# Run the app
$ yarn dev

To run the frontend Web:

# 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.

# Install dependencies
$ yarn

# Run the app
$ yarn start

Now access on your browser: http://localhost:3000

To run the mobile app:

# 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 for more information.

Author

Made with 💜 by Rafael Domingues 👋 Get in touch!