investment-tools

A website that provides variety of tools for personal long-term investment.

Requirements

Web (Website)

1. node.js 20+
2. yarn

Backend

Docker based

1. Docker

non-Docker based

1. Go 1.21+

Setup Project

Common

Run make setup for setting up codebase

Firebase

We use Firebase for user authentication and Firestore for storage (NoSQL).

Here we need to create a firebase project for this project.

Sentry

We use Sentry for performance monitoring and error tracking.

We need to have two sentry project for website and backend each.

Web (Website)

Config

You need to fill environment variables in web/.env to start the website for development

Firebase

For firebase config, fill in variables with prefix APP_FIREBASE.

Sentry

For Sentry config, fill in DSN in APP_SENTRY_DSN.

Backend

You need to fill environment variables in backend/.env to start the backend server for development

Firebase

1. Get Firebase adminSDK credentials file from firebase console. Reference
2. Specify where you put the credentials file in variable FIREBASE_ADMIN_SDK_CREDENTIALS_FILE in .env. Or you may use the default file path.
3. Update the firestore rules by replacing with the rules here

Sentry

For Sentry config, fill in DSN in SENTRY_DSN.

Linter (golangci-lint)

We use golangci-lint for linter. If you want to run linter on local machine. Please follow this link for installation. If you are using docker for development, then no need to install the linter in your machine

Development

Docker based

make dev

Before committing the code, run format and linter first and fix the issues:

make format
make lint

non-Docker based

Please refer to development section for website and backend for non-Docker development

• Web
• Backend