https://github.com/vassourita/proffy

Project made in Next Level Week #2, aiming to connect teachers to students
https://github.com/vassourita/proffy

nextjs nlw nlw-2 nlw-proffy nodejs omnistack proffy react react-native rocketseat

Last synced: 4 days ago
JSON representation

Project made in Next Level Week #2, aiming to connect teachers to students

• Host: GitHub
• URL: https://github.com/vassourita/proffy
• Owner: vassourita
• License: mit
• Created: 2020-08-04T18:10:19.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-01-11T03:33:42.000Z (about 2 years ago)
• Last Synced: 2024-11-26T14:12:53.388Z (2 months ago)
• Topics: nextjs, nlw, nlw-2, nlw-proffy, nodejs, omnistack, proffy, react, react-native, rocketseat
• Language: TypeScript
• Homepage:
• Size: 960 KB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 17
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


   



	



  

  

  

    

  

  



##### :rocket: Project made in Next Level Week #2, aiming to connect teachers to students.

> #### Disclaimer:

 > I participated in every NLW and Omnistack Week since Omnistack #8, but this time I've decided to go beyond what is taught on these events and build a more robust application with automated tests, server side rendering, and a more decoupled code in general, based on the SOLID principles.

# :pushpin: Table of Contents

* [Layout](#pencil2-layout)

* [Technologies](#computer-technologies)

* [How To Run](#wrench-how-to-run)

# :pencil2: Layout

You can see the original layout by @tiagoluchtenberg for the application on Figma:

- [Mobile Layout](https://www.figma.com/file/e33KvgUpFdunXxJjHnK7CG/?viewer=1&node-id=)

- [Web Layout](https://www.figma.com/file/GHGS126t7WYjnPZdRKChJF/?viewer=1&node-id=)

If you can't see the layouts by any reason, this should help:

- [Other ways to see the layout](https://www.notion.so/Layout-Proffy-3d5f45f54ec54ef9b2103565b7cce4e1)

# :computer: Technologies

This project was made using the follow technologies:

- [Typescript](https://www.typescriptlang.org/)

- [Docker](https://www.docker.com/)

- [NextJS](https://nextjs.org/)

- [Styled Components](https://styled-components.com/)

- [ReactJS](https://reactjs.org/)

- [React Native](https://reactnative.dev/)

- [Expo](https://expo.io/)

- [Express](https://expressjs.com/en/api.html#express)

- [Jest](https://jestjs.io/)

- [PostgreSQL](https://www.postgresql.org/)

# :wrench: How To Run

To run this app on your computer, run these commands inside the repository root folder

```shell

# open the backend, install dependencies, run docker:

$ cd packages/server/api

$ yarn

$ cd ./docker

$ docker-compose up -d

# rename .env.example to .env and add your database credentials, then run migrations:

$ cd ../

$ yarn db:migrate

# start the server

$ yarn start:dev

# open another shell again on the repository root folder, install dependencies then start the web server

$ cd packages/client/web

$ yarn

$ yarn dev

# open one more shell again on the repository root folder, install dependencies then start the expo server

$ cd packages/client/mobile

$ yarn

$ yarn start

```