Mukumbuta/Team-opossum-debtor

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• ❓ FAQ
• 📝 License

📖 [My Debtors]

[My Debtors] is a Debt Management web application that helps schools to have precise and accurate data of how much their clients owe them.

🛠 Built With

Tech Stack

Product Design

• Sketch Design

Frontend

• JavaScript

• CSS

• HTML

• React.js

• NPM

Backend

• Python

• Django web framework

• Django Rest Framework

• PIP

• Git

Server

• Express.js

• Django Developemnt Server

Key Features

• [Landing page]
• [Register]
• [Loging]
• [Verify Email]
• [Reset Password]
• [Get all Debtors]
• [Get single debtor]
• [Debtor profile]
• [Complaints/Suggestions]
• [Simple_and_easy_to_use_UI]

(back to top)

💻 Getting Started

To get a local copy up and running, follow these steps.

Prerequisites

In order to run this project you need: []Frontend

• Node
• npm

[]Backend

• PIP
• Python v3.8

Setup

Clone this repository to your desired folder:

  cd your-folder
  https://github.com/zuri-training/Team-opossum-debtor.git

Install

Install this project with:

  cd Team-opossum-debtor
  npm install

  []For Backend
  - Create virtual environment
  pip install -r requirements.txt

Usage

To run the project, execute the following command:

[] Frontend:

  npm run build
  npm run start

[] Backend:

 python manage.py runserver

(back to top)

👥 Contributors

👤 Chukwuji Chinaza

• GitHub: @Chukwuji
• Twitter: @Chukwuji
• LinkedIn: Chukwuji

👤 Emmanuel Simasiku

• GitHub: @Mukumbuta
• Twitter: @Mukumbuta8
• LinkedIn: Mukumbuta

👤 Chimezie Ochuba

• GitHub: @chimezdev
• Twitter: @chimezdev
• LinkedIn: chimezdev

👤 Agorye Ingwu

• GitHub: @ingwukevin
• Twitter: @ingwukevin
• LinkedIn: ingwukevin

👤 Amaku Chidiebele

• GitHub: @Cybergirls273
• Twitter: @Cybergirls273
• LinkedIn: Cybergirls273

👤 Ebuweme Ayo

• GitHub: @Lebrin-Ay
• Twitter: @Lebrin-Ay
• LinkedIn: Lebrin-Ay

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project and you find it helpful, please give this project a star.

(back to top)

🙏 Acknowledgments

We would like to thank everyone who inspired our codebase.

(back to top)

📝 License

This project is MIT licensed.

(back to top)