About | Layout | Setup | Resources | TODO | Contributions | Author | License

Proffy - It's a marketplace where anyone can offer classes as well as consult the available offers. A teacher give his contact infos (name, whatsapp, bio) and classes infos (subject, weekday and available time windows). The platform is able to record this entries on a relational database and are disposable to be queried by interested students.

Developed during the NLW - Next Level Week#02 offered by Rocketseat.

1. Install Git
2. Use a code/text editor, the used one was the VSCode

# Clone this repo
$ git clone https://github.com/viniciusriosfuck/proffy

# Move to the project folder
$ cd proffy


# Install the dependencies
# on Visual Code you can do the following
# npm to run servers
$ npm install

# Start the  server
$ npm start

# The server will be started on port:5500 - access as http://localhost:5500 

We used the following resources on this project:

1. HTML - Hypertext Markup Language - structure the pages
2. CSS - Cascading Style Sheets - to format the pages
3. JavaScript - programming language used to interact with the pages
4. NodeJS - to run js scripts
5. Nunjucks - templating engine - to add code chunks to html files (v: 3.2.2)
6. Express - to build web apps and APIs on js (v: 4.17.1)
7. Nodemon - enables restart the server when files are updated (v: 2.0.4)
8. SQLite - to create the relational database on SQL (Structured Query Language)
9. Sqlite-async - to consult the database with js (v: 1.1.0)

Look at the file package.json

1. Save the database

• present status: as the server is closed the database is lost

2. Display the time of the offers

• present status: only displays name, avatar, cost, bio of the teachers with offers whose time window contain the selected time

3. Deploy the app

• present status: runs on a local server

4. Add funcionalities

• Delete new hour entry, e.g. by miss click, is required to send the entry
• Update the visualization counts (static on 200 visualizations)

1. Fork this repo
2. Create a branch with the suggesting changes: git checkout -b my-feature
3. Save the changes and create a commit describing them: git commit -m "feature: My new feature"
4. Send your changes: git push origin my-feature

This project is under the MIT license.