gagigante / Proffy-NLW2

This project is a online platform to help students to find teachers to learn specific subjects.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Proffy

Proffy

GitHub language count Repository size GitHub last commit Repository issues License

Technologies   |    How to run   |    Project   |    How to contribute   |    License


Frontend

πŸš€ Technologies

This project was developed with the following techs:

πŸ’» Project

This project is a online platform to help students to find teachers to learn specific subjects.

πŸƒ How to run

BACKEND:

Just access the fold backend and run:

To install dependencies

  $ yarn
  
  or

  $ npm install

To run the migrations

  $ yarn knex:migrate

  or

  $npm run knex:migrate

To start the server

  $ yarn start

  or

  $ npm start

WEB:

Just access the fold frontend and run:

To install dependencies

  $ yarn
  
  or

  $ npm install

To start the server

  $ yarn start

  or

  $ npm start

MOBILE:

First you need to edit the file api.js with your current IP address.

mobile/src/services/api.js

import axios from 'axios';

const api = axios.create({
  baseURL: 'http://YOUR_IP_ADDRESS:3333',
});

export default api;

So access the fold mobile and run:

To install dependencies

  $ yarn
  
  or

  $ npm install

To start the server

  $ yarn start

  or

  $ npm start

πŸ€” How to contribute

  • Fork this repo;
  • Create a branch for your new feature: git checkout -b my-feature;
  • Commit your changes: git commit -m 'feat: My brand new feature';
  • Push it to your branch: git push origin my-feature.

After merge of your pull request, you can delete your branch.

πŸ“ License

This project is under MIT license. See the file LICENSE for details.


About

This project is a online platform to help students to find teachers to learn specific subjects.

License:MIT License


Languages

Language:TypeScript 75.3%Language:CSS 23.9%Language:HTML 0.6%Language:JavaScript 0.2%