Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stefanosaffran/proffy
📚 Proffy - Developed during the event NLW 2.0 by @Rocketseat
https://github.com/stefanosaffran/proffy
backend docker frontend mobile nextlevelweek nodejs postgres proffy react-native reactjs rocketseat teach theme-switcher typeorm typescript
Last synced: about 1 month ago
JSON representation
📚 Proffy - Developed during the event NLW 2.0 by @Rocketseat
- Host: GitHub
- URL: https://github.com/stefanosaffran/proffy
- Owner: StefanoSaffran
- License: mit
- Created: 2020-08-03T12:11:26.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-12-15T02:58:05.000Z (11 months ago)
- Last Synced: 2023-12-15T03:57:22.587Z (11 months ago)
- Topics: backend, docker, frontend, mobile, nextlevelweek, nodejs, postgres, proffy, react-native, reactjs, rocketseat, teach, theme-switcher, typeorm, typescript
- Language: TypeScript
- Homepage:
- Size: 734 KB
- Stars: 11
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.MD
- License: LICENSE
Awesome Lists containing this project
README
📚 NextLevelWeek 2.0 📚
Project |
Built with |
How to run |
License |
Get in touch
🚧 Under Construction 🚧
## :computer: Project
Proffy is an application that aims helping to bring together people who need help in some subject with those who like to teach.
## :rocket: Built with
This project was developed with the following technologies:
Server
- [Node.js](https://nodejs.org/)
- [Express](https://expressjs.com/)
- [TypeORM](https://typeorm.io/)
- [Typescript](https://www.typescriptlang.org/)
- [TS-Node-Dev](https://www.npmjs.com/package/ts-node-dev)
- [Tsyringe](https://github.com/microsoft/tsyringe)
- [uuidv4](https://www.npmjs.com/package/uuidv4)
- [Cors](https://www.npmjs.com/package/cors)
- [ESLint](https://eslint.org/)
- [Prettier](https://prettier.io/)
- [VS Code](https://code.visualstudio.com/)
Web
- [React](https://pt-br.reactjs.org/)
- [Typescript](https://www.typescriptlang.org/)
- [@unform](https://unform.dev/)
- [Styled Components](https://styled-components.com/)
- [Context API](https://reactjs.org/docs/context.html)
- [React-toggle](https://github.com/aaronshaf/react-toggle)
- [React-toastify](https://github.com/fkhadra/react-toastify)
- [Axios](https://www.npmjs.com/package/axios)
- [React Icons](https://react-icons.netlify.com/#/)
- [Yup](https://github.com/jquense/yup)
- [ESLint](https://eslint.org/)
- [Prettier](https://prettier.io/)
- [VS Code](https://code.visualstudio.com/)
Mobile
- [React](https://pt-br.reactjs.org/)
- [React Native](https://reactnative.dev/)
- [Expo](https://expo.io/learn)
- [Styled Components](https://styled-components.com/)
- [Typescript](https://www.typescriptlang.org/)
- [React Navigation](https://reactnavigation.org/)
- [Axios](https://www.npmjs.com/package/axios)
- [Expo Google Fonts](https://github.com/expo/google-fonts)
- [React Native Appearance](https://github.com/expo/react-native-appearance)
- [ESLint](https://eslint.org/)
- [Prettier](https://prettier.io/)
- [VS Code](https://code.visualstudio.com/)
## :information_source: How to run
### Requirements
To run the application you will need:
* [Git](https://git-scm.com)
* [Node](https://nodejs.org/)
* [Yarn](https://yarnpkg.com/)
I strongly recommend using [Docker](https://www.docker.com/) to run the databases.
If you decide to use docker, follow this steps to install and run the docker image.
```bash
# 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.
```bash
# 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](https://typeorm.io/#/using-ormconfig).
```bash
# run migrations
$ yarn typeorm migration:run
# run api
$ yarn dev:server
```
### Frontend
```bash
# 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](https://expo.io/learn) to get start with Expo.
```bash
# install the dependencies
cd mobile
yarn
```
In order to run the application on your device, you need to change the ip config.
[api.ts](https://github.com/StefanoSaffran/proffy/blob/master/mobile/src/services/api.ts)
```javascript
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.
```bash
# 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.
## :memo: License
This project is under the MIT license. See the [LICENSE](https://github.com/StefanoSaffran/proffy/blob/master/LICENSE) for more information
## :mailbox_with_mail: Get in touch!
---
Made with :coffee: and ❤️ by Stefano Saffran.