johnggli / Proffy

Project developed during the Rocketseat's NextLevelWeek#2.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Proffy

Project developed during the Rocketseat's NextLevelWeek#2.

GitHub top language Node version Yarn version Made by Repository size GitHub last commit

About the project   |    Technologies   |    Getting started   |    How to contribute   |    Get in touch

πŸ’‘ About the project

  • This project is about a system that seeks to connect students to teachers on an online platform.

πŸš€ Technologies

Technologies that I used to develop this project

πŸ’» Getting started

Backend

Run the migrations:

cd server
yarn install
yarn knex:migrate

Start the API:

cd server
yarn start

Frontend

To start the React's frontend, run:

cd web
yarn install
yarn start

Mobile

First, add the address of your server (or computer) in the file mobile/src/services/api.js, and then run the commands:

cd mobile
yarn install
yarn start

Once the process is finished, the localhost: 19002 page will automatically open in your browser. Connect your emulator, or test the app via LAN: download the Expo app from the Play Store or App Store and then scan the QR code.

πŸ€” How to contribute

Make a fork of this repository

# Fork using GitHub official command line
# If you don't have the GitHub CLI, use the web site to do that.

$ gh repo fork JohnEmerson1406/Proffy

Follow the steps below

# Clone your fork
$ git clone your-fork-url && cd Proffy

# Create a branch with your feature
$ git checkout -b my-feature

# Make the commit with your changes
$ git commit -m 'feat: My new feature'

# Send the code to your remote branch
$ git push origin my-feature

After your pull request is merged, you can delete your branch

🌟 Extras


Made with β™₯ by John Emerson πŸ‘‹ Get in touch

About

Project developed during the Rocketseat's NextLevelWeek#2.


Languages

Language:TypeScript 76.3%Language:CSS 22.6%Language:HTML 0.9%Language:JavaScript 0.2%