Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/victordantasdev/woobank
💵 A banking system build with Koa, Relay and graphql.
https://github.com/victordantasdev/woobank
cypress graqhql jest koa react relay storybook tailwindcss typescript
Last synced: 3 months ago
JSON representation
💵 A banking system build with Koa, Relay and graphql.
- Host: GitHub
- URL: https://github.com/victordantasdev/woobank
- Owner: victordantasdev
- License: mit
- Created: 2024-06-03T02:13:53.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-06-03T16:37:49.000Z (8 months ago)
- Last Synced: 2024-10-01T02:04:44.174Z (4 months ago)
- Topics: cypress, graqhql, jest, koa, react, relay, storybook, tailwindcss, typescript
- Language: TypeScript
- Homepage: https://woobank-web.vercel.app
- Size: 473 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# WooBank 💵
WooBank is a simple web app that simulates a banking system. With WooBank, you can register, log in, perform transactions between accounts, and view the transaction history and account ledger.
## Table of Contents
- [WooBank](#woobank)
- [Technologies Used](#technologies-used)
- [Frontend](#frontend)
- [Backend](#backend)
- [Features](#features)
- [Installation and Project Setup](#installation-and-project-setup)
- [Prerequisites](#prerequisites)
- [Steps](#steps)
- [Accessing the Application](#accessing-the-application)
- [Additional Commands](#additional-commands)
- [Running Tests](#running-tests)
- [Starting Storybook](#starting-storybook)
- [Application Screenshots](#application-screenshots)
- [Deployment](#deployment)
- [License](#license)
## Features
- User registration
- User login
- Perform transactions between accounts
- Access transaction history
- View account ledger and account balance
## Installation and Project Setup
### Prerequisites
- Node.js installed
- Yarn installed
### Steps
1. **Install dependencies**
```sh
yarn
```
2. **Start the database**
```sh
yarn compose:up
```
3. **Set up environment variables**
```sh
yarn set:env
```
4. **Generate the GraphQL schema**
```sh
yarn schema
```
5. **Run the Relay compiler**
```sh
yarn relay
```
6. **Start both backend and frontend**
```sh
yarn dev
```
### Accessing the Application
- The API will be available at: [http://localhost:4000/graphql](http://localhost:4000/graphql), where you will find a playground to test the available queries and mutations.
- The web application will be available at: [http://localhost:3000](http://localhost:3000).
### Additional Commands
- **Start only the server**
```sh
yarn dev:server
```
- **Start only the web application**
```sh
yarn dev:web
```
### Running Tests
- **Run tests with Jest**
```sh
yarn test
```
- **Run component tests with Cypress**
```sh
yarn cypress:component
```
- **Run all tests**
```sh
yarn test:all
```
### Starting Storybook
```sh
yarn storybook
```
## Application Screenshots
- Login page:
- Registration Page:
- Home page:
- Account Ledger:
## Deployment
The application is available at: [https://woobank-web.vercel.app/](https://woobank-web.vercel.app/)
## Technologies Used
### Frontend
- **React**
- **TypeScript**
- **Vite**
- **Cypress**
- **TailwindCSS**
- **Chadcn/ui**
- **Relay**
- **Storybook**
### Backend
- **TypeScript**
- **Relay**
- **Koa**
- **Jest**
## License
This project is licensed under the [MIT License](LICENSE).
---
We hope you enjoy using WooBank! If you have any questions or suggestions, feel free to open an issue in the repository.