Skip to content

Your new way of being financially responsible.

License

Notifications You must be signed in to change notification settings

ruanjkz/saveway

Repository files navigation

Saveway

Your new way of being financially responsible

Saveway is an open-source financial management app designed to empower individuals to take control of their finances. With a focus on budgeting, investment tracking, and cryptocurrency management, Saveway provides an intuitive and secure way to manage your personal finances while staying true to the principles of open-source software.

Features

  • Expense Tracking: Automatically categorize and track your expenses to stay on top of your budget.
  • Investment Monitoring: Connect investment accounts and track portfolio performance.
  • Crypto Integration: Manage and monitor cryptocurrency assets alongside traditional investments.
  • Transaction History: View detailed transaction histories and cash flow summaries.
  • Budgeting Tools: Set and manage budgets for different categories and monitor your spending habits.
  • Financial Insights: Get tailored recommendations to help you improve your financial health.
  • Secure & Private: Your data is encrypted, ensuring security and privacy.

Why Open Source?

Saveway is committed to transparency and community-driven development. By making the app open-source, we allow anyone to contribute to its growth, customize it to their needs, and ensure that personal finance tools remain accessible to everyone.

Getting Started

Prerequisites

To build and run Saveway locally, you will need:

  • A computer with Node.js and pnpm installed.
  • A basic understanding of React and JavaScript for contributing or modifying the code.
  • A GitHub account to submit contributions or report issues.

Installation

Clone the Repository

git clone https://github.com/yourusername/saveway.git

Install Dependencies Navigate to the project directory and install the required packages:

cd saveway
pnpm install

Run the App Locally To run Saveway on your local machine, use the following command:

npm start

Access the App After starting the app, open http://localhost:3000 in your browser to see the app in action.

Contributing

We welcome contributions from the community to make Saveway better for everyone! Whether you’re fixing a bug, adding new features, or improving documentation, your contributions are always appreciated.

To contribute:

Fork the Repository

  • Click the "Fork" button at the top-right of this repository to create a copy of the project under your GitHub account.

  • Create a Branch

  • Create a new branch for your feature or bug fix:

git checkout -b feature-name

Make Your Changes Implement your changes in the code.

Once you're happy with your changes, commit them:

git commit -m "Your commit message"
git push origin feature-name
  • Create a Pull Request

Go to the GitHub repository and create a pull request to merge your changes into the main branch.

Security

We take security seriously. All sensitive information such as user data is encrypted, and we use secure APIs to handle financial transactions. We encourage developers to review and audit the code to ensure that Saveway adheres to the highest security standards.

Support

If you have questions or need help using or developing Saveway, you can reach us at:

Email: [email protected] (temporary) Issues: Report an issue Website: UNRELEASED

License

Saveway is licensed under the MIT License. See the LICENSE file for more information.

About

Your new way of being financially responsible.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published