https://github.com/praisespjmt/pennywise
PennyWize is a mobile web application where you can manage your budget: you have a list of expense associated with a group, so that you can see how much money you spent and on what.
https://github.com/praisespjmt/pennywise
nodejs postgresql reactjs sequelize typescript
Last synced: about 2 months ago
JSON representation
PennyWize is a mobile web application where you can manage your budget: you have a list of expense associated with a group, so that you can see how much money you spent and on what.
- Host: GitHub
- URL: https://github.com/praisespjmt/pennywise
- Owner: PraisesPJMT
- License: mit
- Created: 2023-07-10T15:48:30.000Z (almost 3 years ago)
- Default Branch: development
- Last Pushed: 2023-08-18T07:27:04.000Z (almost 3 years ago)
- Last Synced: 2025-02-04T12:52:03.929Z (over 1 year ago)
- Topics: nodejs, postgresql, reactjs, sequelize, typescript
- Language: TypeScript
- Homepage:
- Size: 403 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
- [📗 Table of Contents ](#-table-of-contents-)
- [📖 PennyWize ](#-pennywize-)
- [🛠 Built With ](#-built-with-)
- [⚙️ Tech Stack ](#️-tech-stack-)
- [💡 Key Features ](#-key-features-)
- [🎞️ UML Diagram ](#️-uml-diagram-)
- [🚀 Live Endpoint ](#-live-endpoint-)
- [💻 Getting Started ](#-getting-started-)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Usage](#usage)
- [👥 Authors ](#-authors-)
- [🔭 Future Features ](#-future-features-)
- [🤝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [❓ FAQ ](#-faq-)
- [🙏 Acknowledgments ](#-acknowledgments-)
- [📝 License ](#-license-)
> `PennyWize` is a mobile web application where you can manage your budget: you have a list of expense associated with a group, so that you can see how much money you spent and on what.
> Here are the tech stacks applied in this project.
Language
Database
Frameworks
> The following are the key features of the app
- Type safety using TypeScript
- User management
- Budget grouping, editing, deleting and customization management
- User dashborad customization
> Coming soon ...
> Coming soon ...
> Coming soon ...
### Prerequisites
> The following applications are required to be installed for the project to run!
- Install a modern browser e.g [Google Chrome](https://www.google.com/chrome/), [Edge](https://www.microsoft.com/en-us/edge?r=1), [Firefox](https://www.mozilla.org/en-US/exp/firefox/new/) etc.
- Install [PostgreSQL](https://www.postgresql.org/download/) database
- Install [Node.js](https://nodejs.org/en/download/) LTS version
- Install [Git](https://git-scm.com/downloads)
### Setup
Clone this repository to your desired folder:
```sh
git clone git@github.com:PraisesPJMT/PennyWise.git
cd pennywize
```
### Install
Install this project with:
```sh
npm install
```
### Usage
To set up the server
```sh
npm sever
```
To set up the client
```sh
npm client
```
To run the project, execute the following command:
```sh
npm run dev
```
- After running `npm run dev`, use the endpoint on [http://localhost:5134/](http://localhost:5134/)!
👤 **Praises Tula**
[](https://github.com/PraisesPJMT/)
[](https://www.linkedin.com/in/praises-tula/)
[](https://twitter.com/PraisesPJMT/)
[](mailto:praisesmusa@gmail.com)
[](https://angel.co/u/praises-tula/)
> The following are features to be expected in the future
- [ ] **Reorder expenses & groups by dragging**
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
Give a ⭐️ if you like this project!
- **How I can run this project?**
- After cloning repository, move to the server directory using the terminal command `cd pennywize/server`, run `npm install` to install all dependencies. Then run `npm run dev` to run the project.
- After doing the above, move to the client directory using the terminal command `cd ../client`, run `npm install` to install all dependencies. Then run `npm run dev` to run the project.
> - Tip hart to you for checking this project out
This project is [MIT](./LICENSE) licensed.