proj_debtors-team-36

Background

This is a platform that allows schools in a certain locality to list the directory of people owing them so as to avoid debtors applying to other schools with pending debts. The website will also enable schools to keep the debt summary (amount that has been paid and collected) and track debts of various students and also give the debtors access to challenge information put up by the schools. -Team 36

Table of Contents

• Background

• About the Project

• Directory Structure

• Installation

• Technologies Used

• Features

• Product Specification

• Usage

• Project Status

• Collaboration

• Contributors

• Documentation

• Acknowledgements

  About the Project

• My_debtors is a website that allows schools in a certain locality to list the directory of people owing them so as to avoid debtors applying to other schools with pending debts.

• This project was created to solve/avoid the problem of students applying to another school in the locality while still having pending or uncleared debts from their previous school.

• This project is solely aimed at schools to help keep the aformentioned problem in check and also allows the students that have posted as debtors to challenge and contend the post.

Directory Structure for server deployment

• The backend files can be found in the school_app and school_prj folder
• The __school_prj__ is the django Project directory
• The user accounts and Authentication backend files are in the account folder
• The Front-end files(Html, css and js plus images) are in the static folder
• The backend templates for the sign up and sign in are in the templates folder
• The invididual contribution .md files for each team member are in the tasks folder
• Monlolith Django templating is being used for the project
• The requirements.txt file contains the required dependencies installed for the project

Instructions for deployment

To run server locally on windows, it is assumed that you have python 3 and git cli/desktop installed

• Clone the repo - https://github.com/zuri-training/proj_debtors-team-36.git

• cd to the sub folder of the repo

• To create virtual environment, run the command python -m venv proj_debtors-team-46

• To activate virtual environment, run proj_debtors-team-36\Scripts\activate

• Run python -m pip install django to install django in the virtual environment

• use the command pip install -r requirements.txt to install all the dependencies

• After this, go a step into the repo folder with the command cd proj_debtors-team-36

• Run python manage.py runserver to start the local server running

• Visit homepage on your browser by entering 127.0.0.1.8000 on your browser address

  Technologies Used

  This project was created with and the following technologies were used:
  

• Design
  

• Frontend
  

• Backend
  

• Database
  

• Project Management and Version Control
  

Features

Unauthenticated users - An individual that has not registered to the website

• The website Home page (Landing page). This page will contain:
  
  • A Hero section with a CTA to Login or Create Account
  • About Us section
  • FAQs section
  • Contact Us section
  • Footer section * Authenticated Users - A user that has fully registered and has completed all the verification processes in the website
• Login to the website
• Dashboard to edit profile
• Add new debtor
• Full access to Data
• CRUD priviledge
• Comment on posts
• Change Password
• List of schools in locality
• Help and Support

• Log out

  Debtor - An individual that has been posted on the website by an authenticated user as a debtor

• Contend/ challenge post

Product Specialization

• Mobile Phones
• Tablets
• Laptops

Usage

• Visit the website
• Surf through basic infromation
• Sign up
• Fill registration details
• Verify email address
• Proceed to KYC verification
• Submit required verification documents
• Get verified
• Log in
• Edit profile
• Full CRUD priviledge

  Project Status

  Project is : in progress

Collaboration

For team_36 members, follow the following steps to collaborate:

1. Visit the Repository to the Project on Github Website: https://github.com/zuri-training/proj_debtors-team-36

2. Fork the repository: Click the "Fork" button on the upper right corner of the Repo page.*

3. Make a local clone: Click on the "Code" button on the Repo page Copy the URL for the forked Repo "https://github.com/github_username/proj_debtors-team-36.git" Create a Folder on your Local machine / Computer for the project Workspace Open Command prompt / Terminal in the same folder location In your Terminal, type:
   git clone https://github.com/github_username/proj_debtors-team-36.git

4. Open terminal and set upstream branch:
   git remote add upstream https://github.com/zuri-training/proj_debtors-team-36

5. Pull upstream to get up to date with the original repo:
   git pull upstream main

6. Create a new branch for the task you are working on :
   git checkout -b branchName
   (Make sure your branchName is descriptive in context to the feature you are working on. Also be sure to check which branch you are on using git status before you begin working)

7. When you're done with your task, do:
   git add
   

   • Commit your work with a message:
     git commit -m "message"

8. To avoid conflicts:
   git pull upstream main

9. Then push your branch:
   git push origin branchName - This creates the branch remotely and pushes to that branch on the Github

10. Go to Github and create a new pull request to the main branch. It will then be reviewed and merged into the master.

If you need to make an update, repeat from no 4 (Skip no 6)

Contributors

Molokwu Chibuzor(Team Lead)

• Github- https://github.com/Jaycarlx
• Track - Fullstack
• Email - molokwuchibuzorchristian@gmail.com

Ebitobodenyefa Spiff(Assistant Team Lead)

• Github- https://github.com/MillySpiff
• Track - Product design

Ambrose Otundo

• Github- https://github.com/Ambroseotundo
• Track - Fullstack

Ngozi Hannah Opara

• Github- https://github.com/Ngozi-opara
• Track - Fullstack

Aduragbemi Oroja

• Github- https://github.com/Izraelight
• Track - Product Design

Adelakin Isreal

• Github- https://github.com/Ezrahel
• Track - Backend(Python)

Omolade Temitope

• Github- https://github.com/MhizTemmie
• Track - Product Design

Ayodele Samuel Tosin

• Github- https://github.com/A-sammyyy
• Track - Product Design

Tolu Joel

• Github- https://github.com/toluisjoel
• Track - Backend(Python)

Ugwu Abel Ikenna

• Github- https://github.com/Abel-hub0456
• Track - Fullstack

John Blessing Awa

• Github- https://github.com/Blessing-John
• Track - Fullstack

Victoria Akilapa

• Github- https://github.com/drvicky007
• Track - Product Design

Taiwo Odeyemi

• Github- https://github.com/TaiwoOdeyemii
• Track - Product design

Princess Salami

• Github- https://github.com/DURDOLA
• Track - Product Design

Samuel Ogusanya

• Github- https://github.com/PsalmogunsGRT
• Track - Fullstack

Bilewu Iyinoluwa

• Github- https://github.com/iyin0
• Track - Fullstack

Umeh Valentine

• Github- https://github.com/Edo-Sketch
• Track - Product Design

Rita Sylvia

• Github- https://github.com/ritasylvia
• Track - Backend

Lasaki Taiwo

• Github- https://github.com/Tamazing
• Track - FullStack

Henry Udeani

• Github- https://github.com/Udeani
• Track- Backend

Jeremiah Nosakhare

• Github- https://github.com/Jeremiahnosakhare
• Track- Product Design

Osadere Gideon

• Github- https://github.com/OGidos
• Track- Product Design

John Amakoh

• Github- https://github.com/JohnChizzy
• Track- Fullstack

Iniubong Abasi

• Github- https://github.com/IniubongJ
• Track- Product Design

Documentation

The documentaion that includes details on how the project was built from the backend, prerequisites, installation procedures, etc can be found here - "Documentationlinkwhenready"

Design

The design for this project was done by the product design team on figma. Check out the design here

Project Documentation

A more detailed documentation on the updates,features and details of this project can be found here

Acknowledgements

This project is acknowlegded to Zuri Team for creating this organization and bringing about this project. Special thanks to the sponsors too.