Skip to content

Latest commit

 

History

History
78 lines (50 loc) · 1.53 KB

README.md

File metadata and controls

78 lines (50 loc) · 1.53 KB

FrogCrypto

FrogCrypto is a monorepo managed with Turborepo, designed to create an interactive and engaging experience for Devcon attendees through the collection of virtual and physical frogs. The project integrates multiple frameworks and packages to deliver a seamless experience across web and mobile platforms, leveraging technologies like Express, Next.js, and Vite.

Table of Contents

Installation

  1. Clone the Repository

    git clone https://github.com/yourusername/frogcrypto.git
cd frogcrypto

  2. Install Dependencies

    Ensure you have Node.js installed (version >= 18).

    pnpm install

Usage

Development

Run all services in development mode:

pnpm dev

This command starts the API server, admin panel, and client app simultaneously with hot-reloading enabled.

Building for Production

Build all packages and applications:

pnpm build

Cleaning Build Artifacts

Remove all dist directories:

pnpm clean

Linting

Check the code for linting errors:

pnpm lint

Testing

Run all tests:

pnpm test

Project Structure

  • apps/: Contains all the applications (API server, admin panel, client app, etc.).
  • packages/: Houses shared packages and utilities used across different applications.
  • docs/: Documentation and planning materials.