Finote

Table of Contents

• Introduction
• Overview
• Requirements
• Installation
• Project Roadmap

Introduction

Welcome to the Finote repository! This project provides the necessary functionality to support financial note-taking and organization. This README file will guide you through the installation, usage, and other important details of the Finote Project.

Overview

This project is a mono repo project that consists of two main components: the front end and the back end. The front provides a user-friendly interface for users to create, view, and manage their financial notes. The Backend is responsible for handling data storage, retrieval, and processing.

The Backend uses NestJS, a powerful and efficient Node.js framework for building scalable and maintainable server-side applications. It provides a RESTful API that allows the Finote front end to communicate with the backend and perform CRUD operations.

We use PostgreSQL, a powerful open-source relational database management system known for its reliability, scalability, and advanced features. To communicate with the database, we use TypeORM, a popular Object-Relational Mapping (ORM) library for TypeScript and JavaScript. It simplifies database operations and provides a more intuitive and type-safe way to interact with the database.

Requirements

Before you can run the Finote, make sure you have the following prerequisites installed on your system:

1. Node.js (version 20.15.1 or higher) (this project includes the asdf version manager)
2. Yarn (version 1.22.19 or higher)
3. PostgreSQL (version 15.0 or higher)
4. Email service (e.g., SendGrid, Mailgun, etc.) for sending account verification emails. Or for testing, you can use Mailtrap
5. Docker (optional for running the project in a containerized environment)
6. A Sentry account (optional for error tracking and monitoring)

Installation

Before proceeding, we assume you have a PostgreSQL database set up and running with a new empty database. Then, clone the repo (if you want to contribute, better use fork).

git clone https://github.com/skyjackerz/finote-project.git
cd finote-project

After the clone, please follow the instructions I've included below.

Environment Variables

1. Create a .env file in the root directory

2. Generate a random string to create a cookie secret. Here, we will use the openssl command:

   openssl rand -hex 64 | tr -d "\n"

   And paste the result to the .env file as COOKIE_SECRET

3. Fill in the .env file with the following variables:

   TZ=UTC
   NODE_ENV=development # development or production
   DEBUG=true
   
   COOKIE_SECRET=your_generated_cookie_secret
   
   SERVER_PORT=3000
   SERVER_SENTRY_DSN=your_server_sentry_dsn # optional
   
   CLIENT_PORT=3001
   CLIENT_SENTRY_DSN=your_client_sentry_dsn # optional
   
   
   DATABASE_HOST=your_database_host
   DATABASE_PORT=your_database_port
   DATABASE_USERNAME=your_database_username
   DATABASE_PASSWORD=your_database_password
   DATABASE_NAME=your_finote_database_name
   
   MAIL_HOST=your_mail_host
   MAIL_USERNAME=your_mail_service_username
   MAIL_PASSWORD=your_mail_service_password

Build & Deploy

1. Install dependencies:

   yarn install

2. Database Migration:

   yarn server:migration-run
   yarn server:seed-run

3. Deploying:

   docker compose --env-file .env -f .docker/docker-compose.yml up --build -d

Project Roadmap

• User Management
• Authentication
• Account Management
• Transaction Management
• Category Management
• Web App Build
• Budget Management
• Reporting and Analytics