Proffy is an online study platform that helps people find teachers online. This is the web version.
All the resources used by this application comes from its API.
- Screenshots
- Installation
- Getting Started
- Found a bug? Missing a specific feature?
- Contributing
- License
Click to expand.
You need to install Node.js and Yarn first, then in order to clone the project via HTTPS, run this command:
git clone https://github.com/monteiro-alexandre/proffy-web.git
SSH URLs provide access to a Git repository via SSH, a secure protocol. If you use a SSH key registered in your Github account, clone the project using this command:
git clone git@github.com:monteiro-alexandre/proffy-web.git
Install dependencies
yarn install
Or
npm install
Create your environment variables based on the examples of .env.example
cp .env.example .env
After copying the examples, make sure to fill the variables with new values.
| key | description | example |
|---|---|---|
| REACT_APP_API_BASE_URL | API's url | http://localhost:3333 |
Run the following command to start the application in a development environment:
yarn start
Feel free to file a new issue with a respective title and description on the the Proffy web repository. If you already found a solution to your problem, I would love to review your pull request! Have a look at our contribution guidelines to find out about the coding standards.
Check out the contributing page to see the best places to file issues, start discussions and begin contributing.
This project is licensed under the MIT License - see the LICENSE file for details.