college-portal / ux-prototype

UX Prototype for College-portal. See Process flow in issues

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)

ux-prototype's Issues

Logo Design

We need a cool logo!

Email Template List

• Welcome User
• Email Verification (contains verification call-to-action link/button)
• Forgot Password (contains reset-password call-to-action link/button)
• Welcome to new Semester (from school to all its participants)
• Welcome to new Session (from school to all its participants)
• Transfer School Ownership (to previous and new owners)

Come up with design specs and theme

What's the user creation flow?

• Draft a user creation flow

UX Planning checklist

UX Checklist

• UX Research
  • Review similar projects - ✅
  • Brainstorm and get users' opinions ✅
  • Define KPI Link ✅
• Plan
  • Define user stories Link ✅
  • Define red routes Link
• Prototype (Done along side Con/Comm - UX)
  • Rough brainstorm sketch (Screen Planning)
  • Wireframe
  • Prototype
• Content/Communication (Done along side prototype - UI)
  • Define App language/persona - Youthful Persona (Pop culture/Generation Z) ✅
  • Define content strategy
  • Define Brand (colors, logos...) - Colors:Blue/Orange Font: Poppings ✅
  • Get prototype approved (pre-development)
• Create
  • Define and Create reuseable components
  • Create static screens
  • Connect to APIs **
• Refine
  • Measure and Optimize performance
  • Get User feedback and refine
  • Measure against KPI
• Razzmattaz
  • Add transitions
  • Add micro interactions
  • Add micro copies
• Analyse
  • Define post launch KPIs
  • Define test plans
  • Include analytics

What's the school creation and setup flow?

School Creation Flow

• Name e.g. (University of Lagos)
• Short Name e.g. (UNILAG)
• Logo
• Add Current User as Staff
  • Staff Title (e.g. Mr., Mrs., Dr., Prof.)
• Invite at least one Staff (optional)
• Setup Level System
  • Name (unique) e.g. 100 Level or Year 1
• Setup Semester Types
  • Name (unique) e.g. 1st Semester
• Setup Session
  • Name (unique) e.g. 2018/2019
  • Start Date e.g. 2018-09-01
  • End Date e.g. 2019-09-01
  • Setup Semester
    • Choose Semester Type
    • Start Date e.g. 2018-09-01
    • End Date e.g. 2019-09-01
• Setup Grading System
  • Name (unique) e.g. A
  • Value (integer between 1 and 5) e.g. 5
  • Minimum Score (number) e.g. 75
  • Maximum Score (number) e.g. 100
• Setup Faculties (at least one)
  • Name (unique)
  • Choose a Dean (from Staff)
  • Setup Departments (at least one)
    • Name (unique)
    • Choose an HOD (from Staff)
    • Setup Programs (at least one)
      • Name (unique)
    • Setup Courses (at least one)
      • Title (unique)
      • Code (unique)
      • Credit (number)
      • Choose Semester Type
      • Choose Department
      • Choose Level
      • Assign Staff to Course
        • Choose Staff
        • Choose Semester