Update root README

This commit is contained in:
Prathamesh Musale 2025-02-06 11:42:32 +05:30
parent fc8ead078a
commit 4bec1fa5d9

View File

@ -17,22 +17,26 @@ This project is a Solana-based meme generator that allows users to connect their
## Setup ## Setup
- Install dependencies: - Install dependencies:
```sh ```sh
npm install npm install
``` ```
- Copy the `.env.example` file to `.env.local` and add your API keys: - Copy the `.env.example` file to `.env.local` and add your API keys:
```sh ```sh
cp .env.example .env.local cp .env.example .env.local
``` ```
- Add your FAL AI key to the `.env.local` file: - Add your FAL AI key to the `.env.local` file:
```env ```env
# Get key from https://fal.ai/ # Get key from https://fal.ai/
FAL_AI_KEY=your_fal_ai_key FAL_AI_KEY=your_fal_ai_key
``` ```
- Setup a project on <https://app.pinata.cloud> then add the following to `.env.example`: - Setup a project on <https://app.pinata.cloud> then add the following to `.env.example`:
```env ```env
# Get keys from https://app.pinata.cloud/developers/api-keys # Get keys from https://app.pinata.cloud/developers/api-keys
PINATA_JWT= PINATA_JWT=
@ -40,6 +44,7 @@ This project is a Solana-based meme generator that allows users to connect their
``` ```
- Run the development server: - Run the development server:
```sh ```sh
npm run dev 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. - Connect your Solflare or Phantom wallet using the "Connect Wallet" button.
- Select an AI model and enter a prompt to generate a meme. - 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. - 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`