School - API

Instructions in portuguese

What is the project about?

• Student Enrollment Management
• SPA to use this API

Features

Access

• Student
• Responsible (Parents)
• Teachers
• Administradors (Directs of the all schools)

Registers

• Schools
• Parents
• Teachers
• Students
• Enrollments
• Transports
  • Vehicles
  • Drivers
  • Routes
• Classes
  • Enrollments
  • Frequencies
  • Grades
  • Subjects
  • Quizzes
• Calendars
  • School calendar

Rules

• Registers

  Before registering a student, the Student Mother will be registered.   A mother can have children of different parents.

• CLASSES Associate Classes with Matters, being able to select the teachers enrolled for that subject and valuing if the teacher not associated to another class or school in the selected period.   Associate Professor with Subjects;   Address the issue of substitute teacher;

• Enrollments You can enroll a student in a class, OR, enroll several at a time, that is, at the end of the year, approved students may migrate from grade 3 to grade 4.

• Transports Create transport routes.   Link students to routes.

• Teachers Release of absences, removals and attestations.

Dashboard

• Widgets

Dependencies

• php 7.2
• mysql 5.7
• redis

php extensions

Some php extensions are required. I recommend installing the extensions below, although not all of them are mandatory in this project:

php7.2-bcmath \
php7.2-common \
php7.2-cgi \
php7.2-curl \
php7.2-dev \
php7.2-gd \
php7.2-intl \
php7.2-json \
php7.2-mysql \
php7.2-mbstring \
php7.2-pgsql \
php7.2-sqlite3 \
php7.2-xml \
php7.2-zip \
php-apcu \
php-imagick \
php-memcached \
php-redis

How to install

Installation video in Portuguese

Demo video in Portuguese

composer create-project emtudo/school-api
cd school-api
php artisan jwt:generate

Configure the .env file before executing the command below to create the database tables:

php artisan migrator

How to test

php artisan serve

Admin (Default)

• username: [email protected]
• password: abc123

Routes