Getting Started
Installation
Guide to install and set up Currencia
Prerequisites
Before installing Currencia, ensure you have the following prerequisites installed on your system:
- Bun (version 1.1.34 or higher)
- Git
- PostgreSQL (for main database)
- MongoDB (for temporary storage)
- RabbitMQ (for message queue)
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 modebun dev:app- Start only the main applicationbun dev:formatter- Start only the formatter servicebun run:scripts- Execute utility scriptsbun build- Build all applicationsbun build:app- Build only the main applicationbun build:formatter- Build only the formatter servicebun test- Run testsbun lint- Run lintingbun lint:fix- Fix linting issuesbun typecheck- Run TypeScript type checking
