Home-management-platform

A web app that makes organising your housework easily.
Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Tests
5. Roadmap
6. Contributing
7. Contact
8. Acknowledgments

About The Project

The purpose of the application is to make household activities easier.
The application aims to create a dashboard-type work environment to which only family members or friends/flatmates can access. This should allow users to create groups where other members can join. Access to groups is conditionated by a code. All members of a group can create tasks within it. A user that completes many tasks receives awards and can exchange tasks using its awards.

(back to top)

Built With

This section should list any major frameworks/libraries used to bootstrap your project.

• Django
• Django REST Framework
• React.js
• Redux
• Chakra-ui
• SqlLite

(back to top)

Getting Started

Prerequisites

• python3
• npm
• npx
• Node.js - at least v. 15.0

Installation

Use a terminal for the following steps:

1. Clone the repo

   git clone [email protected]:Homeify/Home-management-platform.git

Open backend django app

2. Install pip packages

   pip install -r requirements.txt

3. Run migrations

    python manage.py makemigrations

   python manage.py migrate

4. Open django admin app

   python manage.py runserver

   Open server in a browser (optional).
   To access adminhomeify pannel (contains info about all modules) access /admin from django server and add admin credentials.

Open frontend app

5.  cd frontend

6. Install NPM packages

   npm install

7. Open react app

   npm run start

(back to top)

Usage

API Documentation:

Visit swagger folder for HTML documentation for each endpoint.

Useful phyton commands:

• python manage.py create super user - creates an admin that can access administration backend platform (can see/add/edit entities)
• pip freeze > requirements.txt - add local requirements in requirements.txt file

(back to top)

Run tests

• python manage.py tests
• coverage run manage.py test
• coverage run manage.py test

(back to top)

Roadmap

• JWT login system
• Groups
• Admin actions on group
• Tasks
• Customise tasks
• Comments
• Receive rewards in a group and decline task
• Frontend
• User badges
• Multi-language Support

(back to top)

Contributing

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

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

Contact

Iuga Paula - [email protected]

Project Link: https://github.com/Homeify/Home-management-platform

(back to top)

Acknowledgments

Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off!

• Postman
• Postman to swagger
• Redoc CLI
• Swagger open api
• GitHub Pages
• Font Awesome
• React Icons

(back to top)