https://github.com/matheus1714/financial-data-storage
This repository contains a sample user transaction database over a period of 1 year.
https://github.com/matheus1714/financial-data-storage
docker environment neon postgres sql
Last synced: about 1 year ago
JSON representation
This repository contains a sample user transaction database over a period of 1 year.
- Host: GitHub
- URL: https://github.com/matheus1714/financial-data-storage
- Owner: Matheus1714
- License: mit
- Created: 2023-08-30T13:10:48.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-09-06T00:42:46.000Z (almost 3 years ago)
- Last Synced: 2025-03-16T11:51:20.898Z (over 1 year ago)
- Topics: docker, environment, neon, postgres, sql
- Language: Python
- Homepage:
- Size: 143 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Financial Data Storage 📊
This repository contains a sample user transaction database over a period of 1 year.
## Technologies 🛠️
* Docker 🐳
* Postgres 🐘
* Python 🐍
## Model Entity Relationship (MER) 🗄️
This project revolves around three key entities:
1. **Customers** 👤: These are the bank's valued users.
2. **Accounts** 💳: Represents user accounts across different banks.
3. **Transactions** 📈: Captures user account transactions.
Dive into the `/sql/init.sql` file for a detailed `SQL` script with all entity definitions.
## Running the Project 🚀
To run this project follow these steps:
### Local Database
1. Clone the repository from GitHub:
```shell
git clone https://github.com/Matheus1714/financial-data-storage.git
```
2. Ensure you have [Docker](https://www.docker.com/) installed on your machine.
3. Open your terminal and navigate to the project's root directory.
4. Change the `.env.example` file to `.env`
```env
PG_CONNECTION_STRING=postgres://postgres:postgres@database:5432/finantialdb
```
5. Run the following command:
```shell
docker-compose up --build
```
This command orchestrates the magic defined in the `docker-compose.yaml` file. It'll spin up the database and populate it with the wealth of information encapsulated in the entity relationship model.
The database population process is orchestrated by the `mock_dataset.py` file.
### Remote Database
1. Follow step 1 from [Local Database](#local-database)
2. Create an account at [https://console.neon.tech/](https://console.neon.tech/) and generate a database and tables with file `sql/init.sql`.
3. Take connection url and add and replace in `.env` file:
```env
PG_CONNECTION_STRING=... // Add your remote connection string here
```
4. Install [virtualenv](https://pypi.org/project/virtualenv/) in python
```shell
pip install virtualenv
```
5. Generate a virtual environment
```
virtualenv venv
```
6. With the virtual environment active in the terminal, install the requirements file dependencies
```
pip install -r requirements.txt
```
7. Run the `mock_dataset.py` file
```shell
python mock_dataset.py
```
## Accessing the Database 📡
Accessing the database is a breeze! Connect using the following credentials:
```python
DB_USER = 'postgres'
DB_PASSWORD = 'postgres'
DB_NAME = 'finantialdb'
BD_PORT = 2222
```
For local runs, set the host as `localhost` or `0.0.0.0`.
Hungry for data insights? Simply visit `localhost:8080 `in your browser.
## Docker Tasks at a Glance 🐋
### Task: Configure the Database
```yaml
database:
image: postgres
ports:
- "2222:5432"
environment:
POSTGRES_USER: postgres
POSTGRES_PASSWORD: postgres
POSTGRES_DB: finantialdb
command: [ "postgres", "-c", "log_statement=all" ]
restart: always
volumes:
- ./sql/init.sql:/docker-entrypoint-initdb.d/init.sql
```
### Task: Database Interface
```yaml
adminer:
image: adminer
restart: always
depends_on:
- database
ports:
- 8080:8080
```
### Task: Configure Mock Dataset
```yaml
mock_app:
build:
context: .
dockerfile: Dockerfile.mock_app # Specify the Dockerfile for your mock app
depends_on:
- database
```
## License 📜
This project is open-source and is distributed under the MIT License. Feel free to explore, modify, and utilize the codebase according to the terms outlined in the license. 🤝🌟