Getting Started

Installation

Guide to install and set up Currencia

Prerequisites

Before installing Currencia, ensure you have the following prerequisites installed on your system:

Project Structure

Currencia is organized as a monorepo using Turborepo, with the following structure:

currencia/
├── apps/
   ├── app/         # Main Nuxt application
   └── formatter/   # Data formatter service
├── packages/        # Shared packages and utilities
├── scripts/         # Data provider scripts
└── package.json

Installation

To install Currencia, follow these steps:

Clone the repository

terminal
git clone https://github.com/hugorcd/currencia.git

Install dependencies

terminal
bun install

Environment Setup

Copy the .env.example file to .env and fill in the values:

terminal
cp apps/app/.env.example apps/app/.env
cp apps/formatter/.env.example apps/formatter/.env

Or using Shelve:

terminal
npx @shelve/cli pull
You're now ready to start the application! 🚀
terminal
bun run dev

Available Scripts

  • bun dev - Start all applications in development mode
  • bun dev:app - Start only the main application
  • bun dev:formatter - Start only the formatter service
  • bun run:scripts - Execute utility scripts
  • bun build - Build all applications
  • bun build:app - Build only the main application
  • bun build:formatter - Build only the formatter service
  • bun test - Run tests
  • bun lint - Run linting
  • bun lint:fix - Fix linting issues
  • bun typecheck - Run TypeScript type checking
Copyright © 2025