EDUK

Project developed at the Rocketseat - BOOTCAMP LAUNCHBASE.

Table of Contents

1. About The Project
   • Built With
   • Objective
   • Status
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. License
5. Contact
6. Acknowledgments

About The Project

It is a personal classes management application that organizes and correlates information about Teachers and Students.

(back to top)

Built With

• HTML
• CSS
• Javascript
• Node.js
• Nunjucks (template engine)
• Express.js (server)
• PostgreSQL (database)

(back to top)

Objective

Project developed for educacional purposes.

(back to top)

Status

Finished.

(back to top)

Getting Started

Prerequisites

• npm

  npm install npm@latest -g

• PostgreSQL

Installation

1. Clone the repo

   git clone https://github.com/MarioDoncel/Eduk-Launchbase

2. Install NPM packages

   npm install

3. Run on PostgreSQL the queries that are in database.sql to create a database "eduk" and the tables "teachers" and "students".

4. Configure your access to database on src/config/db.js

   module.exports = new Pool({
      user: "postgres",
      password: "xxxxxx",
      host:"localhost",
      port: "5432",
      database: "eduk"
    });

5. Run the application

   npm start

(back to top)

Usage

• Teachers Page - Here you can see all Teachers registered showing their avatars, names, subjects that they teach and the number of students they have. Two are shown per page. You can filter the results by name or subject.

• Teachers Details/Create/Edit Pages - Here you have the pages to show, create, edit and delete Teachers.

• Students Page - Here you can see all Students registered showing their avatars, names, emails and education levels. Two are shown per page. You can filter the results by name or education level.

• Students Details/Create/Edit Pages - Here you have the pages to show, create, edit and delete Students.

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Mario Andres Doncel Neto

Email - 88mario.doncel@gmail.com
Whatsapp - +55 19 99612 9909

Project Link: https://github.com/MarioDoncel/Eduk-Launchbase

(back to top)

Acknowledgments

• Rocketseat

(back to top)