Skip to content

tinathuybui/dca-calculator

Repository files navigation

Netlify Status

1. Introduction

Welcome to the Dollar Cost Averaging Calculator!

2. Installation

Prerequisites

Ensure these dependencies are installed before proceeding:

node -v
# 18.16.1

yarn -v
# 3.6.1

If you don't have these installed, please visit Node.js official website and Yarn Package Manager to download and install them.

Installing Project Dependencies

Install project dependencies using Yarn with the --immutable flag to ensure consistent package versions:

yarn install --immutable

3. Running the Project Locally

To run the project locally, execute the following command:

yarn dev

4. Running Linters

Run the following command to execute the linter:

yarn lint

5. Running Tests

You can also run tests to ensure the project's functionality:

yarn test

6. Contributing

If you'd like to contribute to the project, please check the How to contribute file for guidelines and instructions.