Skip to content
Abdul Malik edited this page Mar 27, 2021 · 6 revisions

Description ( Wiki under construction ⚠️ )

Introduction

OU Notes is an application to [Upload, Download, Upvote, Downvote, Report] Documents.

Each document may contain Notes, Previous Question Papers, Syllabus and links to helpful resources.

These documents are further organized into subjects offered by my university πŸ“˜πŸ‘¨β€πŸŽ“

Why my university ?

Well.. let's take an example of a subject called Database Management Systems. Your university might call it Management Database Systems or some other university might call it System Databases , in fact IT (Information Technology) students from my university have the exact same subject named Database Systems .

So you get it, there's a bunch of names so to decrease this complexity we zeroed in on only one university for now.

Do we intend to expand to other universities?

Ofcourse ! this is the whole reason we are open-source. Let's all get together and make an application for every university on the planet ! Can't wait to see your contribution.

Pre-Requisites ( i.e what you need to know to contribute )

Flutter

This one is obvious.

Stacked Architecture

This is the architecture we used to build the application.

Don't panic if you haven't heard this, just go through this playlist on YouTube and you're good to go

JavaScript ( optional )

The Firebase Cloud Functions part of the application uses JavaScript, and if you intend to contribute you might need to know it.

Setup and Configuration

coming soon.. ( i only have 2 hands you see )

Introduction

Requirements

subtopic

Setup and Configuration

subtopic

Architecture

subtopic

Testing

subtopic

Contribution

subtopic

Clone this wiki locally