- Introduction
- Technologies
- project Setup
- Illustrations
- Project Information
- Contributing
- Acknowledgments
Why fmd-repo?
One simple system to track the financial health of your architectural firm. Plan projects, resource staff, log time, track revenues and make profits!
usage
The programme is able to intuitively :
- Recording all the projects' data
- Recording all the transactions' data
- Track net revenue, expenditures and profits with a button
Rules of the game
- Consistently update the project and transaction data and leave the rest to me 😊
Builth With
- Python
- mysql
- sqlalchemy
- You will need a desktop or a laptop computer.
- RAM: A minimum of 4GB RAM is recommended.
- Disk Space: You should have at least 5GB free of space on your working hard drive.
environment
The project was developed in (wsl2 ubuntu environment) .
Prerequisites
To get this project up and running locally, you must already have the following installed:
- python plus the necessary packages installed on your computer
- code editor
- mysql workbench
- mysql server installed on your terminal
simple steps to set up on your local machine
- git clone
https://github.com/symonkipkemei/fmd-repo.git
- Load mysql schema on your database using mysql workbench, (in the schema directory)
- set up your root/database password as virtual environment variable
- set up and activate the virtual environment.
- install dependencies
pip install -r requirements.txt
- Run on terminal main.py
Project Status
- Complete
features
- a receipt validator, for ease of filing taxes
- online platform that can interact with the user( built on django)
- usd/kes that can easily adapt to the rates.
- Your suggestions 😊............
Contributions, issues and feature requests are always welcome!
I love meeting other developers, interacting and sharing.
Feel free to check the issues page.
How to Contribute
To get a local copy up and running follow these simple example steps.
- Fork the repository
- git clone https://github.com/your_username/fmd-repo
- git checkout develop
- git checkout -b branch name
- git remote add upstream https://github.com/symonkipkemei/fmd-repo
- git pull upstream develop
- git commit -m "commit message"
- git push -u origin HEAD
👤 Symon Kipkemei
- Github: symonkipkemei
- Twitter: @symon_kipkemei
- LinkedIn: Symon kipkemei
I can't promise to solve all your problems but I promise you won't have to face them alone 😊.
Finally, if you've read this far, don't forget to give this repo a ⭐️.