Cashmere Monorepo

This repository contains a monorepo project for the Cashmere platform, which uses SST for AWS stack management, Pnpm for dependency management, NX for task management, and other tools like Pino, TypeBox, Prettier, and Vitest.

Table of Contents

• Prerequisites
• Getting Started
• Libraries
• Folder Structure
• Shared
• Backend
• Frontend
• Global Considerations

Prerequisites

Before getting started with the Cashmere Monorepo project, ensure that you have the following tools and configurations set up on your development environment:

1. Node.js: The project uses a specific Node.js version specified in the .nvmrc file. To manage multiple Node.js versions, you can use NVM (Node Version Manager). Install NVM and then run nvm install and nvm use to set the correct Node.js version for this project.

2. AWS CLI: The project relies on the AWS CLI for managing AWS resources. Install the AWS CLI and configure it with your AWS credentials by following the official AWS CLI documentation.

3. Pnpm: The project uses Pnpm for dependency management. Install Pnpm globally on your development environment by following the official Pnpm installation guide.

4. NX: The project utilizes NX for task management. Although it's not required to install NX globally, you can familiarize yourself with NX by reading the official NX documentation.

Ensure that you have all the prerequisites set up before proceeding with the "Getting Started" section of the README.

Getting Started

To get started with the project, make sure you have the AWS CLI configured on your computer. Then, follow these steps:

1. Clone the repository.
2. Install dependencies with pnpm install.
3. Start the development server with pnpm dev.

Libraries

• SST: For managing AWS stacks efficiently
• Pnpm: For fast monorepo dependency management
• NX: For powerful task management
• Pino: For logging
• TypeBox: For type checking
• Prettier: For code formatting
• Vitest: For unit testing

Folder Structure

The project is organized into the following folder structure:

• shared: Shared components between front and back.
  • contracts: Contains type definitions for every HTTP handler, ensuring valid requests and responses and helping with typing for both backend and frontend.
• backend: Backend related components.
• frontend: Frontend related components.

Shared

Contains shared components between front and back, such as:

• Blockchain ABIs and addresses
• API routes types and responses
• contracts: Type definitions for every HTTP handler, helping the backend to type Lambda input and ensure valid requests and responses, as well as assisting the frontend with typing.

Backend

Contains backend related components, organized as follows:

• core: Core libraries and configuration for the backend.
• blockchain: Blockchain related components for backend interaction.
• services: Business logic per feature.
• functions: Lambda functions per feature and endpoint group.
• database: Database related components.
• cache: Cache related components.

Frontend

The frontend folder contains all components and resources related to the Cashmere platform's user interface. The frontend is organized into subfolders for better modularity and maintainability.

The current frontend folder structure is as follows:

• web/exchange: The initial project for migration. It contains all the existing frontend components and resources for the Cashmere exchange platform.

In the future, the frontend folder structure will be organized into a more modular structure, similar to the backend folder structure:

• core: This folder will contain core libraries, utilities, and configurations specific to the frontend.

• components: This folder will house reusable UI components, such as buttons, form elements, and layout components, which can be shared across different parts of the frontend or even across different Cashmere projects.

• features: This folder will be used to organize the frontend code based on different features or sections of the application, such as account management, trading, or analytics.

• styles: This folder will include global styles, themes, and other styling resources for the frontend.

• assets: This folder will contain static assets like images, fonts, and other media files used in the frontend.

By organizing the frontend folder in this manner, it will be easier to navigate, understand, and maintain the frontend codebase, as well as promote code reusability and modularity.

Global Considerations

When contributing to the Cashmere Monorepo project, it is essential to understand the overall architecture and organization of the code. The project is structured as a monorepo, containing both frontend and backend components with shared resources. The AWS infrastructure is managed using SST, and tasks are executed using NX. This setup allows efficient deployment and management of AWS stacks, making it easier to work with different environments like dev, preprod, and prod.

When writing new code for this project, consider the following guidelines:

1. Modularity: Write modular code by organizing your features into separate folders within the backend or frontend directories. This will help in maintaining a clean and organized codebase.

2. Stack Independence: Ensure that each stack is independent and can be managed without impacting others. This will allow for more efficient deployments and updates.

3. Code Reusability: Leverage shared components and resources in the shared folder whenever possible. This will help reduce code duplication and promote better maintainability.

4. Consistent Coding Style: Follow the established coding style, including using Prettier for code formatting and adhering to the linter rules.

5. Testing: Write unit tests for your code using the Vitest framework to ensure its reliability and maintainability.

6. Documentation: Document your code, including comments and README updates, to help other contributors understand your changes and how they fit into the project.

By adhering to these guidelines, you will contribute to the project's maintainability, scalability, and overall code quality.