stuDebt

Background 💡

The rate at which debt is killing the school business is quite alarming, and most especially the private schools. A lot of cases have been recorded, whereby a student owes a school and after a while the student disappears to another school, without reconciling his/her debts.

Table of Contents 📚

• Background
• About the Project
• Technologies Used
• Features
• Product Specification
• Usage
• Project Status
• Collaboration
• Roadmap
• Contributors
• Documentation
• Acknowledgements

About the Project 📖

This stuDebt platform is centred on helping schools prevent debtors from registering in another school despite pending debts in the previous school.
The platform enables schools to upload names of debtors and also check for the debt record of each student before registering the student.
The stuDebt platform also allows students to challenge every debt that they believe is not consistent with the amount they had paid.

Technologies Used ✨

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

• Design
  

• Frontend
  

• Backend
  

• API
  

• Database
  

• Project Management and Version Control
  

Features 🔥

Unauthenticated users - A user that is yet to be registered on our platform

• The landing page (i.e. the website home page) consists of the following:
  
  • The Hero page with a CTA to either “Sign Up” or “Login”, Circulars, FAQs, Contact Us.
    
  • Why the platform is beneficial.
    
  • Reviews from other proprietor/proprietress.
    
  • Newsletter section.
    
  • Footer Section.

Authenticated Users - A user that has been registered on our platform either as a school or as a student.

• Registered as a school:
  Upon registration and verification of the school using her CAC number. The school would be able to do the following:
  • Log in to the website
    
  • Update debtors record (i.e. add/remove debtors from her schools debtors list)
    
  • School’s Dashboard
    
  • Full access to Data
    
  • Search for debtors record
    
  • Comment on posts
    
  • Change password
    
  • Help & support
    
  • Log out
• Registered as a student:
  Upon registration and verification of the student using his/her NIN. The student would be able to do the following:
  • Log in to the website using his/her NIN and password
    
  • Access to only his/her profile
    
  • Contend his/her debt
    
  • Log out

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 🤝

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

Getting Started

Setting up project locally is a pretty easy step.

1. Clone the repo

   git clone https://github.com/zuri-training/My_debtors_Team35.git

2. Move into the project directory

   cd My_debtors_Team35

3. Create a virtual environment

   python -m virtualenv venv 

4. Activate the virtual environment

   venv\Scripts\activate

5. Move into the Backend Directory

   cd Backend

6. Install pip dependencies

   pip install -r requirements.txt

   
   Create a new Postgres Database Using pgAdmin or psql on terminal

Default user: postgres

Set the database name to studebt_db1

Create a .env file inside the Backend directory and store SECRET_KEY='' and your postgres password DB_PASSWORD=''

7. Move into the studebt directory

   cd studebt

8. Make Migrations

   py manage.py makemigrations

9. Migrate to Postres Database

   py manage.py migrate

10. Create a superuser

    py manage.py createsuperuser

11. Run Server

    py manage.py runserver

Roadmap 🚧

See the open issues for a list of proposed features (and known issues).