diff --git a/README.md b/README.md new file mode 100644 index 0000000..2558261 --- /dev/null +++ b/README.md @@ -0,0 +1,73 @@ + +
+ +

+ Foldbank +

+

a mock of the [Fold Money](https://fold.money) website

+
+ + +## Design + +The design is inspired from the image present on the [Fold Money Website](https://fold.money/_next/image?url=%2F_next%2Fstatic%2Fmedia%2Fmockup-web-light.a9e40530.jpg&w=3840&q=75) + + +## Usage + +- Local setup is suppoerted via [Docker](https://docs.docker.com/get-docker/) and [Docker Compose](https://docs.docker.com/compose/) + +```sh +docker-compose up -d +``` + + +### Build + +- Build images for dev + +```sh +docker-compose build +``` + + +### Build images for prod + +```sh +docker-compose -f docker-compose.prod.yml build +``` + + +### Logging + +- To get the logs of all containers + +```sh +docker-compose logs -f +``` + +- To get the logs of a particular container + +```sh +docker-compose logs -f container-name +``` + + +## What this is not + +``` +- A production ready app +- Backend + - Linking of bank account + - Multiple currency handling + - Not considering assets like FD, Stocks + - i18n + - Multi Tenancy + - Authentication +- Web + - Not mobile responsive, intended to be a mockup + - Click to copy + - Hover states + - Menus +``` +