https://github.com/mohammedmoataz/tab-cash
Tab Cash is an e-wallet application represented in an Orange Digital Center Hackathon, which makes it easy to you to send and receive money, show your previous transactions and an additional feature which is parent’s control.
https://github.com/mohammedmoataz/tab-cash
expressjs mongodb mysql-database rest-api swagger
Last synced: 3 months ago
JSON representation
Tab Cash is an e-wallet application represented in an Orange Digital Center Hackathon, which makes it easy to you to send and receive money, show your previous transactions and an additional feature which is parent’s control.
- Host: GitHub
- URL: https://github.com/mohammedmoataz/tab-cash
- Owner: MohammedMoataz
- Created: 2023-05-02T14:51:53.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2024-12-11T21:22:59.000Z (over 1 year ago)
- Last Synced: 2025-01-30T17:55:07.442Z (over 1 year ago)
- Topics: expressjs, mongodb, mysql-database, rest-api, swagger
- Language: JavaScript
- Homepage:
- Size: 302 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Tab-Cash
## Prerequisites
Before you can run the Tab Cash backend, you will need to have the following tools installed on your computer:
- Node.js (version 12 or higher)
- A database system (MySQL and MongoDB)
## Getting Started
To get started with the Tab Cash backend, follow these steps:
1. Clone the Tab Cash repository to your local machine.
2. Install the necessary dependencies by running ```npm install``` in the root directory of the project.
3. Configure the database connection by modifying the .env file.
4. Start the server by running ```nodemon index``` in the root directory of the project.
## Endpoints
The Tab Cash backend provides the following endpoints:
- /: for authentication
- /user: for managing user accounts
- /api-docs: for documentation
## Documentation
Detailed documentation for the Tab Cash project:
- Presentation: [Tab Cash Presentation](https://docs.google.com/presentation/d/1Y5PxaHhdN5fusXXhPzUYh5BvzrisiF3BW8nptjDh3Gs/edit?usp=sharing)
- UI-UX Design:
- [Mobile App](https://www.figma.com/proto/Kt8yRtouY0rHIIrPjcbztV/Tab-Cash?node-id=342-752&t=sPTQOFCioslQjsrd-0&scaling=min-zoom&page-id=0%3A1&starting-point-node-id=167%3A804)
- [Website](https://www.figma.com/proto/Kt8yRtouY0rHIIrPjcbztV/Tab-Cash?node-id=415-739&t=sPTQOFCioslQjsrd-0&scaling=min-zoom&page-id=54%3A927&starting-point-node-id=415%3A739)
- [Landing Page](https://www.figma.com/proto/Kt8yRtouY0rHIIrPjcbztV/Tab-Cash?node-id=801-1371&t=sPTQOFCioslQjsrd-0&scaling=min-zoom&page-id=801%3A1370)
- [Case Study](https://www.figma.com/proto/Kt8yRtouY0rHIIrPjcbztV/Tab-Cash?node-id=641-740&t=sPTQOFCioslQjsrd-0&scaling=min-zoom&page-id=641%3A739)
- Mobile App Repo: [Mobile Repository](https://github.com/HebaAdelAhmed/tap_cash)
## Contributing
If you would like to contribute to the Tab Cash project, please fork the repository and make your changes in a new branch. Pull requests are warmly welcome.
## Swagger Screenshots:
