anuragrao04 / growpal

GrowPal is a software that aids small businesses in apartment societies to grow their customer base.

GrowPal

This is a repository for managing code for the GrowPal project. Please open an issue if you find any!

!! HACKNIGHT SECTION !!

What the project does?

This project aims to build a platform for small scale business owners in apartment societies to connect and sell their products. Business owners now just advertise their products on common WhatsApp groups which becomes spam after a while and the group is muted. This voids any kind of advertisement or online representation for these small scale sellers. You might have seen this happening to people in your apartment society who sell Tupperware bottles, cooking services, small accessories, etc.

What the project is built on?

This project is built on Python and the Qt framework. It is a Desktop Application. It was not intended for production when it was initially developed but was just a prototype to test things.

How can you build the project locally and test?

1. Fork this repository
2. Clone it to your local machine
3. Follow the installation steps highlighted below this section and finally run main.py to execute. The servers are online so make sure to maintain a stable internet connection while running!
4. For contribution guidelines, go to CONTRIBUTE.md

Maintainer In Charge

Contact Anurag Rao

• email: [email protected]
• phone: [phone]

Installation

Build From Source

Make sure the required libraries are installed.

Run main.py to execute. Please contact [phone] or [email protected] if there is an error connecting to the server.

Libraries Required

Run in Command Prompt or an equivalent shell:

pip install PyQt5 validate_email pandas mysql-connector-python imagekitio qdarkstyle dnspython python-dotenv

Font Configuration (optional)

Open the Roboto folder. This folder contains the font files required.

Windows

Head to the Start Menu and open the Settings page.

From here, click the Personlization option, then Fonts.

Next, drag the fonts files onto the installer window. After a few seconds, the Google Roboto font will be installed within Windows.

macOS

Select all of the fonts inside the folder, right-click, and select “Open With -> Font Book” from the context menu.

This will load them into Font Book and will make them available for use in your applications.

Note that you can also double-click the individual font files to load them into Font Book.

Linux

Copy and paste all the font files to ~/.fonts. Please refer your distribution's wiki/forums for further information.