Software Design

This page includes a short description of the overall architecture style of the system, its high-level system components, and their logical (what data they exchange) and control (how they invoke each other) dependencies. Mostly described using diagrams.

Architecture Diagram

A NextJS-Django stack built on Docker and hosted on Cybera. The frontend will be statically built, the django server will be running on a separate container. The server will be running the business and persistence layers. The DB is postgres and will be a docker volume attached to the Django container. In addition emails will be sent through Sendgrid. The frontend will communicate with the backend using REST in JSON (header + body) format.

Arch

UML Class Diagram

This is an ER diagram of the app. There are two main types of accounts, Admin and User. User can follow 0 or many companies. They also have attributes attached to the user and can be extended upon like a mentor. Users can also have badges. Admin manages users, activities and scholarships.

UML

Sequence Diagrams

Multiple sequence diagrams depicting the most important scenarios. There is a diagram for each major user: Organizations, Young Person and Admin.

Sequence

Low-Fidelity User interface

Low-fidelity wireframe of the initial concept. The first image is the landing page. The next is the actual platform where users can use the app to navigate and explore all sorts of items/events.

Low-Fidelity User interface1

Figma Prototype User interface

Prototype User interface1

Reports

View report Generated by DeepSource

(Click Me!) Report

API Documentation

API documentation is available at http://[2605:fd00:4:1001:f816:3eff:fe0d:f6c0]:8000/docs/. Screenshots of the documentation are also included below.

Technology List

Backend

Django

High level Python web framework: https://www.djangoproject.com/

django rest framework

Toolkit for building Web APIs in django. Also provides api test functionality.: https://www.django-rest-framework.org/

djoser

Provides a set of Django Rest Framework views to handle basic authentication actions: https://pypi.org/project/djoser/

Sendgrid

Email delivery platform: https://sendgrid.com/

Swagger

Provides tools for API documentation: https://swagger.io/

Swagger API Docs p1 Swagger API Docs p2 Swagger API Docs p3 Swagger API Docs p4 Swagger API Docs p5 Swagger API Docs p6 Swagger API Docs p7 Swagger API Docs p8 Swagger API Docs p9 Swagger API Docs p10 Swagger API Docs p11 Swagger API Docs p12 Swagger API Docs p13 Swagger API Docs p14 Swagger API Docs p15 Swagger API Docs p16 Swagger API Docs p17 Swagger API Docs p18