This documentation is a work in progress.
Project K is a comprehensive financial management system designed to help individuals and businesses effectively manage their finances. This repository contains the source code for Project K, providing a powerful and customizable solution for various financial needs.
Before you begin with Project K, make sure you have the following prerequisites installed and configured:
- Node.js: The APP is built using
Node.js
. Download and install it from Node.js. - Package Manager (pnpm): Ensure you have
pnpm
installed. Install it usingnpm
withnpm install -g @pnpm/exe
. - Database (postgres): The API relies on a database for data storage. Install and set up a compatible database. Download and install it from Postgres.
- OAuth keys: Create keys at GitHub Developer Settings and Google Cloud Console.
- .NET Core: The API is built using .NET Core 8. Download and install it from .NET Core.
- Seq (optional): Configure Seq for a custom dashboard for logs. Download it from Seq.
- Expense Tracking: Easily record and categorize your expenses to gain insights into your spending habits.
- Budget Management: Set and track budgets to ensure better financial planning and control.
- Income Management: Log and monitor your sources of income for a complete financial overview.
To get started with Project K's API, follow these steps:
- Clone the Repository:
git clone https://github.com/Victorvhn/project-k.git
- Configure appsettings.json
Configure the appsettings.json file (Adapters/Driving/Apis/ProjectK.Api), including Database, Seq, Authentication keys, etc.
Make sure to review and customize the configuration files according to your environment.
- Install dependencies
cd project-k/api && dotnet restore Adapters/Driving/Apis/ProjectK.Api/ProjectK.Api.csproj
- Start the API
dotnet run --project Adapters/Driving/Apis/ProjectK.Api/ProjectK.Api.csproj
- Configure .env
Configure the .env file, including API Url, Authentication provider keys, Authentication Docs, etc.
Make sure to review and customize the configuration files according to your environment.
- Install dependencies
cd project-k/app && pnpm install
- Start the APP
pnpm dev