Skip to content

SavonarolaLabs/ergo-web-template

Repository files navigation

Ergo Web Template

An efficient Svelte-based web template integrated with advanced features like a notification system, a modal component, and Ergo Wallet functionalities.

🛠️ Pre-requisites

Before you begin with the setup, ensure you have the following tools installed:

  • Git: This is required to clone the repository. If not installed, you can download it from git-scm.com.
  • npm: Node Package Manager (npm) is essential for managing project dependencies. It comes bundled with Node.js. If you don't have it, download and install Node.js (which includes npm) from nodejs.org.

🚀 Getting Started

Follow these steps to set up the project locally:

  1. Clone the repository

    git clone https://github.com/SavonarolaLabs/ergo-web-template
    cd ergo-web-template
  2. Install Dependencies

    npm install
  3. Run the Development Server

    npm run dev

    This starts the server and automatically launches the application in your default browser.

📁 Key Files & Directories

Dive into the primary components housed in the src/lib directory:

FleetSDK Integration

This project comes with Fleet SDK, you can see more usage examples in their documentation

🔨 Build the Project

For a production-ready build:

npm run build

The built files will be located in the build directory.

📘 Additional Information

  • Build Pipeline: This project utilizes Trunk. Configuration details are available in .trunk/trunk.yaml.
  • Dependencies: package-lock.json ensures consistent dependency installation across setups.

For an in-depth understanding of Svelte applications, consult the official Svelte documentation.