stefanosaffran/proffy

📚 Proffy - Developed during the event NLW 2.0 by @Rocketseat

📚 NextLevelWeek 2.0 📚

Project   |    Built with   |    How to run   |    License   |    Get in touch

🚧 Under Construction 🚧

💻 Project

Proffy is an application that aims helping to bring together people who need help in some subject with those who like to teach.

🚀 Built with

This project was developed with the following technologies:

Server

• Node.js
• Express
• TypeORM
• Typescript
• TS-Node-Dev
• Tsyringe
• uuidv4
• Cors
• ESLint
• Prettier
• VS Code

Web

• React
• Typescript
• @unform
• Styled Components
• Context API
• React-toggle
• React-toastify
• Axios
• React Icons
• Yup
• ESLint
• Prettier
• VS Code

Mobile

• React
• React Native
• Expo
• Styled Components
• Typescript
• React Navigation
• Axios
• Expo Google Fonts
• React Native Appearance
• ESLint
• Prettier
• VS Code

ℹ️ How to run

Requirements

To run the application you will need:

• Git
• Node
• Yarn

I strongly recommend using Docker to run the databases.
If you decide to use docker, follow this steps to install and run the docker image.

# install Postgres image (if you don't specify an username it will be postgres by default)
$ docker run --name imagename -e POSTGRES_PASSWORD=yourPassword -p 5432:5432 -d postgres

# start Postgres
$ docker start imageName

Backend

Now clone the repository and install the dependencies.

# to clone the repository
$ git clone https://github.com/StefanoSaffran/proffy.git

# go into the server folder
$ cd proffy/server

#install the backend dependencies
$ yarn

In order to connect to the database, you will need to enter the access informations into a ormconfig.json. You can find more about it here.

# run migrations
$ yarn typeorm migration:run

# run api
$ yarn dev:server

Frontend

# in another tab of the terminal install the web dependencies and run it 
$ cd web
$ yarn
$ yarn start

Mobile

The Application was developed using Expo. It is a free and open source toolchain built around React Native to facilitate the process of running and testing applications. Click here to get start with Expo.

# install the dependencies
cd mobile
yarn

In order to run the application on your device, you need to change the ip config.

api.ts

  baseURL: 'http://192.168.0.185:3333',

replace 192.168.0.185 with your machine's ip.

Now with everything on place, run the application.

# to run the app
yarn start

Expo will open a page in your browser, scan the QRcode on the page and wait for the app to load.

The Application was developed and tested on Iphone 6s and Android Studio Emulator.

📝 License

This project is under the MIT license. See the LICENSE for more information

📬 Get in touch!

       

---

Made with ☕ and ❤️ by Stefano Saffran.