diff --git a/README_Prometheus.md b/README_Prometheus.md new file mode 100644 index 0000000..c4da81f --- /dev/null +++ b/README_Prometheus.md @@ -0,0 +1,82 @@ +# Prometheus: Add README for swap-ui-example + +## Project Overview + +A comprehensive Solana DApp (Decentralized Application) boilerplate designed to accelerate frontend development for blockchain developers. This project provides a robust starting point for building web3 applications on the Solana ecosystem, focusing on rapid development and seamless wallet integration. + +### Key Features +- Next.js powered frontend framework +- Built-in Solana wallet adapter integration +- Chakra UI component library for elegant and responsive design +- Pre-configured context providers for wallet and UI management +- Support for token swapping and SPL token interactions +- Modular component and utility structure for easy customization + +### Core Benefits +- Streamlines the initial setup process for Solana web3 applications +- Provides a clean, organized project structure +- Enables quick prototyping and development of decentralized applications +- Offers out-of-the-box wallet connectivity and UI components +- Supports modern web development practices with TypeScript and React + +## Getting Started, Installation, and Setup + +### Prerequisites + +Before getting started, ensure you have the following installed: +- Node.js (version 14 or later) +- npm (version 6 or later) + +### Installation + +1. Clone the repository: +```bash +git clone https://github.com/your-repo/solana-dapp.git +cd solana-dapp +``` + +2. Install dependencies: +```bash +npm install +``` + +### Running the Development Server + +To start the development server with hot reloading: +```bash +npm run dev +``` +The application will be available at `http://localhost:3000` + +### Building for Production + +To create a production build: +```bash +npm run build +``` + +To start the production server after building: +```bash +npm start +``` + +### Project Structure + +- `components/`: Reusable React components + - `common/`: Common UI components like Loading and Notify + - `layout/`: Layout components such as Header +- `pages/`: Next.js pages and route components +- `utils/`: Utility functions and helper scripts +- `styles/`: Global and module-specific styles + +### Key Dependencies + +- Next.js: Web framework +- React: UI Library +- Chakra UI: Component library +- Solana Wallet Adapter: Wallet integration +- Solana Web3.js: Blockchain interactions + +### Wallet Integration + +The project uses Solana Wallet Adapter, supporting multiple wallet connections. Wallet providers are configured in `pages/_app.tsx`. \ No newline at end of file