👀 What is Proffy?

Proffy is an online educational platform that allows student-teacher interaction, developed during Next Level Week #2.

Content

• Getting Started
  • Features
  • Prerequisites
• Requirements
  • Web
  • Server
• Technologies Used
• Issues
  • Report
• Contributing
• License
• Author

Getting Started

📑 Features :

• Teachers Register;
• API Whatsapp;
• Remove Schedule;
• Hearts Counters ;
• Dynamic favicon;
• Night mode;

💻 Prerequisites :

• Git (configure bash in the terminal).
• Visual Studio Code (recommended publisher).

Requirements

• Node Js (updated).

💻 Web :

🚧 This part is under construction... 🚧

📊 Server :

 Clone this repository

 $ git clone <https://github.com/victorialmeida/-Proffy-/nlw1>

 Access the project folder in the / cmd terminal
 
 $ cd Proffy NLW

Technologies Used

• Node.js ;
• ReactJS ;
• SQLite ;
• SQL ;
• Template Engine : Nunjucks.

Issues :

📥 Report :

You can report your problems in Issues section, this is really important.

Contributing :

🤝 First, you need a local fork of the project on your machine.

$ gh repo fork victorialmeida/-Proffy-/

Clone your fork

$ git clone https://github.com/victorialmeida/-Proffy-.git $ cd Proffy NLW

Create a branch with your feature

$ git add {modified file name}

Make the commit with your changes

$ git commit -m “Comments”

Send the code to your remote branch

$ git push origin {branch-name}

License :

📑 The license for this project is MIT, earn more about the License here.

Author :

_{Victória Almeida 💜}

🧠 " This whole project was made during NLW, keep coding! "