Verancial is a service that helps users manage their financial information. It allows users to securely download, store, and process their financial information from banks. This information can be used for data analysis and exporting reports to popular financial apps like BudgetBakers and YNAB.
To run Verancial, you'll need to have the following tools installed:
- Docker
- Go 1.18
Once you have these installed, follow these steps:
-
Clone the repository:
git clone https://github.com/verasthiago/verancial.git -
Navigate to the project root directory:
cd verancial -
Build and run the services using the Makefile:
make build make run
Verancial is a monorepo consisting of the following services:
The API service provides an interface for accessing and managing user financial data.
The Login service provides user authentication and authorization functionality.
The Shared folder contains Go code that is shared across all services.
We welcome contributions to Verancial. To contribute:
- Open an issue to discuss your changes.
- Fork the repository.
- Create a new branch for your changes.
- Make your changes and commit them.
- Push your changes to your forked repository.
- Open a pull request to the main repository.
If you have any questions or concerns, you can reach us at verancial@verasthiago.com or on LinkedIn at https://www.linkedin.com/in/verasthiago/.
We plan to add a CLI in the near future, and possibly a frontend. We're also working on a new service that's currently in development. Stay tuned for more updates!