<<<<<<< HEAD proj_debtors-team -39

Environment Setup Follow these commands to run the project on your local machine :

Open your terminal

Clone the project

git clone https://github.com/zuri-training/Team-39-project-my-debtors.git Enter the project directory

cd deudoras Create a virtual env

Activate your env

pip install -r requirements.txt Make Migrations

python manage.py makemigrations python manage.py migrate Create Superuser

python manage.py createsuperuser Run the server

python manage.py runserver

Background

This is a platform that allows schools in a locality to list the directory of people owing them to help them avoid going to other schools around the area without paying off their debts. It is a platform where school owners can upload the database of students who owe them to the platform to enable track their debtors and the platform makes the database accessible to other schools in the locality that have registered with

Table of Content

About the project
Tools Used
Product specialization
Features
Project Status
Contributors
Acknowledgement

About the project

Many school owners experience financial losses as a result of students who owe and then change their school in order not to pay up their outstanding debts. That is why we came up with Deudoras, a platform for schools to be able to track these debtors even when they try to enroll in another school within their locality.

Deudoras is a website application that enables school owners in Gbagada locality to upload the database of students who are debtors on the platform and make this list of students available to other schools in the community that are registered on the platform. The website application will help school administrators track down debtors and this will go a long way in helping them recover their funds.

    Link to the project research plan - https://docs.google.com/document/d/10n_VLdjgWS-ugrluERfMa1g2AOn7NgqY3hLa-lwtmn0/edit?usp=sharing

Tools Used

VS-Code
Project Documentation - https://docs.google.com/document/d/1oHJR7ExoQC8421zz3bNPVmU-Mnf-74t0Nt4vfdnt1nA/edit
Project Journey(meetings/updates) - https://docs.google.com/document/d/1aL2UL2ZkRyystw6pH0j6J9FmCL3Ub4QCCtkrAkpS-ZY/edit?usp=sharing
Figma -   https://www.figma.com/file/xweedyiijgngZt24JB44rd/Team-39_MyDebtors-Figma?node-id=305%3A98
Figjam - https://www.figma.com/file/GAyXOrMav37WbmE6tUBM5i/User-Research-2-Resources?node-id=0%3A1
Lucidchart - https://lucid.app/lucidchart/49f54d9d-bd2c-4b55-b3f3-8fa6ff830985/view?page=8.HAGRnC1py.#
Github - https://github.com/zuri-training/Team-39-project-my-debtors
Django

Tech Stack : Html Css React Python Django

API : CAC

Endpoint : Laptops and phones

Product Specialization

Desktop
Tablet
Mobile Phones

Server Link

Features

There are two levels of access on the platform; one for unauthenticated users, and the other for authenticated users.

Unauthenticated users:

This access is for anyone who uses our url to visit the platform. They will have access to the basic information about us such as - an overview of the platform, our contact pages and what services we offer. These will be available on the landing page. View and interact with the documentation. There will be a documentation which will list all the goals the platform intends to help clients (school owners) achieve, how to navigate and use the platform effectively, and many more directives. They won't have access to core platform data. This simply means that a user who has not registered won’t be able to access data such as the list of debtors in any school, etc. They will have to register to view more details. There will be more features and documentations to access when a user decides to register.

Authenticated users:

Full access to the platform. All authenticated users will be able to access all the features in the platform. Verify details before full access to the platform. Before full access to the platform is given to registered clients, school owners will have to verify they own the school while students will have to verify that they belong to the school they claim they are in. Post new data about a debtor. Means they have the access to update the list of debtors, when a student becomes a debtor, they have access to post it. Allow debtors to challenge - contend. An individual who has been posted as a debtor will have access to challenge or contend that particular post but can only win when certain conditions are met. Comment on posts by others. There will be a comment box under every post where all every authenticated user can comment.

Project Status

The project status and progress report which involves the tasks allocated and successfully completed can be found in our google sheets down below;

Link to project status

A well detailed documentation of our project journey can be found in our google doc file down below;

Link to project documentation

Contributors

Project Manager: @Zuri
Project Supervisor: @David Black
Team Lead: @canice ezugwu
Assistant Team Leads: @Wunmi Oke, and @Jean-Eudes
Product design Lead: @Wunmi Oke
Assistant Product design Leads: @Oreoluwa and @Phebe Oyine James
Frontend dev Lead: @canice ezugwu
Assistant Frontend Leads: @Kalu Divine and @Psyche
Backend dev Lead: @Jean-Eudes
Assistant Backend Leads: @Amayo Amollo and @Soma
Product designers: @Wunmi Oke @Rihanat @Phebe Oyine James @Cylla  @Peace_Etim @Oreoluwa @Classicrobec @Hamdalah Aliu @Victory @Olaitan Odufuwa @Chukwuebuka Oguchi
Developers: @Canice Ezugwu @Kanu Chibuzo @Gabri @Quilspace @Amayo Amollo @Soma @Jean-eudes @Psyche  @Kalu Divine
Communications Liaison: @Kalu Divine
Documentation of Journey: @Kanu Chibuzo, @Phebe Oyine James, and @Canice Ezugwu
Presentation - @Psyche, @Canice Ezugwu, @Hamdalah Aliu and @Olaitan @Wunmi Oke

Acknowledgement

This project is acknowledged by the Zuri Team organization as they came up with the project idea and contributed massively to the success of this project.

Deudoras

origin/psyche-complete