Live at: peanut.to | staging.peanut.to

Getting Started

Ask in Peanut Discord #dev channel if you have any questions.

First install the dependencies (location: root folder):

pnpm install

cp .env.example .env

pnpm dev

Open http://localhost:3000 with your browser to see the result.

Code Formatting

This project uses Prettier for code formatting. To ensure consistent code style:

1. Install the VSCode Prettier extension
2. Enable "Format on Save" in VSCode
3. Prettier will automatically format your code when you save

The CI pipeline will check formatting on all PRs. Unformatted code will block merging.

Testing

This project uses Jest for testing. Tests are located next to their source files in __tests__ directories.

To run tests:

# Run all tests
pnpm test

# Run tests in watch mode during development
pnpm test:watch

# Run tests with coverage report
pnpm test:coverage

Test Structure

• Tests are placed in __tests__ directories next to the code they test
• Test files should be named *.test.ts or *.test.tsx
• Use descriptive test names that explain the expected behavior

Example:

describe('Bank Account Formatting', () => {
    it('should format IBAN with spaces every 4 characters', () => {
        // test code
    })
})

The CI pipeline runs tests on all PRs. Failed tests will block merging.