Add readme with setup steps #2

Merged
nabarun merged 1 commits from ng-readme into main 2025-01-27 10:11:58 +00:00
2 changed files with 50 additions and 0 deletions

4
.gitignore vendored
View File

@ -2,3 +2,7 @@ node_modules
.next
.env
.env.local
.env.development
.env.production
.env.test

46
README.md Normal file
View File

@ -0,0 +1,46 @@
# sol-mem-gen
This project is a Solana-based meme generator that allows users to connect their wallets, pay with MTM tokens, and generate memes using AI models.
## Features
- Connect to Solflare and Phantom wallets
- Pay with MTM tokens
- Generate memes using various AI models
## Prerequisites
- Node.js
- npm
- Solflare or Phantom wallet
## Setup
1. Install dependencies:
```sh
npm install
```
2. Copy the `.env.example` file to `.env.local` and add your FAL AI key:
```sh
cp .env.example .env.local
```
3. Add your FAL AI key to the `.env.local` file:
```env
# Get key from https://fal.ai/
FAL_AI_KEY=your_fal_ai_key
```
4. Run the development server:
```sh
npm run dev
```
5. Open your browser and navigate to `http://localhost:3000`.
## Usage
1. Connect your Solflare or Phantom wallet using the "Connect Wallet" button.
2. Select an AI model and enter a prompt to generate a meme.
3. Pay the required MTM tokens and wait for the meme to be generated.