Skip to content
Ian Otsembo edited this page Mar 12, 2023 · 4 revisions

Hello there welcome to the MoringaHub wiki page.

The Moringa Library is a web application built as a central repository that features the best of the best Moringa School projects done by our gracious students and their technical mentors.

1. Design

=> Something about general design here

1.1 Product

=> Something about UI design here

1.2 Database

We opted to use a relational database for our application. Our RDBMS of choice is Postgres

The database schema definitions are designed using a popular tool: DB DIAGRAM

Have a look at our database design here

MoringaHub

1.3 Architecture

=> Something about architectural design here (frontend and backend)

2. Application

This application is a web API that allows users to:

Users

A user is an entity that contributes to projects in the library. This is done through making submissions to the library and leaving reviews and ratings on projects.

  • Users can register/log in to the platform using their email addresses or GitHub accounts.
  • Users can add a submission to the library (either a project or an article).
  • Users can update their submissions to the library.
  • Users can delete their submissions to the library.
  • Users can view all their submissions to the library
  • Users can check the status of their submission to the library.
  • Users can add a rating to an existing project in the library.
  • Users can add comments to an existing project in the library.

Reviewers

A reviewer is an entity that has the ability to perform reviews on existing submissions. They are responsible for contributing to the confirmation or rejection of a submission to the library.

  • A reviewer can log in to the platform using their email address. (Based on Moringa School domain)
  • A reviewer can add comments about their review.
  • A reviewer can approve/reject a submission.

Admin

An administrator is an entity with the ability to manage accounts for reviewers.

  • Create an account for a reviewer.
  • Delete a reviewer account.
  • Accept submission to the library.
Clone this wiki locally