From 4bec1fa5d9f1b55cbb60b492ee35d95e4746b342 Mon Sep 17 00:00:00 2001 From: Prathamesh Musale Date: Thu, 6 Feb 2025 11:42:32 +0530 Subject: [PATCH] Update root README --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index 526c803..ccfb9f2 100644 --- a/README.md +++ b/README.md @@ -17,22 +17,26 @@ This project is a Solana-based meme generator that allows users to connect their ## Setup - Install dependencies: + ```sh npm install ``` - Copy the `.env.example` file to `.env.local` and add your API keys: + ```sh cp .env.example .env.local ``` - Add your FAL AI key to the `.env.local` file: + ```env # Get key from https://fal.ai/ FAL_AI_KEY=your_fal_ai_key ``` - Setup a project on then add the following to `.env.example`: + ```env # Get keys from https://app.pinata.cloud/developers/api-keys PINATA_JWT= @@ -40,6 +44,7 @@ This project is a Solana-based meme generator that allows users to connect their ``` - Run the development server: + ```sh npm run dev ``` @@ -51,3 +56,7 @@ This project is a Solana-based meme generator that allows users to connect their - Connect your Solflare or Phantom wallet using the "Connect Wallet" button. - Select an AI model and enter a prompt to generate a meme. - Pay the required MTM tokens and wait for the meme to be generated. + +## Deploy + +Follow [instructions](./deploy/README.md) for deploying `sol-mem-gen` and `sol-token-locker`