Proffy Discovery

---

---

About |  Reason |  Requirements |  Technologies |  How to Use |  How to Contribute |  License

---

ℹ️ About

Proffy is your online study place, give your Whatsapp number so that students could find you or if you just want to study, no problem, search for teachers anytime you want.

⁉️ Reason

Connecting students and teachers is our mission, our challenge, and helping you is all we want.

🌱 Requisitos Mínimos

• NodeJS v12
• Npm v6

🚀 Technologies Used

The project was developed using the following technologies

• Node
• SQLite3
• Express
• Nunjucks

🎒 How to Use

1. Clone this repository

   $ git clone https://github.com/wejesuss/proffy-discovery && cd proffy-discovery
   # You can also download the zip in your repository page

2. Install Dependecies and Run

   $ npm install
   # start the API
   $ npm start

The website should be running on http://localhost:5000/, access with a browser

🔗 How to Contribute

• Fork this repostory

1. Using github CLI

   # You can also use the second option
   $ gh repo fork wejesuss/proffy-discovery

2. Using the website

   1. You just need to click the 'Fork' button on the top of this page

• Clone your fork

  $ git clone https://github.com/your-username/proffy-discovery && cd proffy-discovery
  # You can also download the zip in your repository page

• Create a branch with your changes

  $ git checkout -b my-awesome-changes

• Make the commit with your changes

  $ git commit -m 'fix: 42'

• Push your branch

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

• Pull request your changes

Licença

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