College Portal

An open source Rest API for a modern online portal for tertiary institutions including

• Universities
• Polytechnics
• Colleges of Education

Status

• Under Active Development

Setup

• Clone this repository
• Checkout the edge branch. git checkout edge
• Be sure to have Laravel Development Environment setup on your system
• Copy the .env.example file to a .env file and update its values
• Run composer install to install dependencies
• Create an App Key with php artisan key:generate
• To use the image upload feature
  • Create a cloudinary account
  • Fill the CLOUDINARY_* fields in .env
• Create a MySQL, PostgreSQL or SQLite DB and connect it via the .env file
• Add the migrations to the DB by running php artisan migrate
• To seed your DB with test data, run php artisan db:seed
• To serve the application, run php artisan serve

Rest API Documentation

The documentation exists here.

Technologies

• PHP (Laravel)
• MySQL

Contribution Guide

See our guide for contributors.

A Peek (ER Diagram)