Myc 120

.env.example

@@ -1,17 +1,5 @@
-NEXT_PUBLIC_NEYNAR_CLIENT_ID=
-NEYNAR_CLIENT_ID=
-NEYNAR_API_KEY=
-NEXT_PUBLIC_REFERRAL=
-SOUND_API_KEY=
-NEYNAR_CLIENT_ID=
-SUPABASE_URL=
-SUPABASE_KEY=
-NEXT_PUBLIC_SPOTIFY_CLIENT_ID=
-SPOTIFY_CLIENT_SECRET=
-STACK_SYSTEM_ID=
-STACK_API_KEY=
-NEXT_PUBLIC_ANON_KEY=
-NEXT_PUBLIC_SUPABASE_URL=
-NEXT_PUBLIC_THIRDWEB_CLIENT_ID=
 PRIVY_APP_ID=
-PRIVY_APP_SECRET=
+PRIVY_APP_SECRET=
+REWARDS_DEPOSIT_POINT_SYSTEM_ID=
+STACK_API_KEY=
+STACK_POINT_SYSTEM_ID=

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 Sonata
+Copyright (c) 2024 sweetman.eth
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,43 +1,78 @@
-# sonata
+# myco API 🌟
 
-music client for farcaster
+myco API is a powerful tool designed to help developers and creators leverage the Zora ecosystem more effectively. It provides a suite of endpoints that simplify interaction with Zora's blockchain data and offer valuable insights. 🚀
 
-supports music on
+## Tech Stack 🛠️
 
-- Spotify
-- Soundcloud
-- Sound.xyz
-- Zora (coming soon)
+- **Frontend**: Next.js 14, React 18, TypeScript
+- **Styling**: Tailwind CSS, shadcn/ui
+- **Backend**: Next.js API Routes
+- **Blockchain Interaction**: viem
+- **Authentication**: Privy
+- **Analytics**: Stack
+- **Deployment**: Vercel
 
-# Setup
+## Getting Started 🏁
 
-1. Download and install Docker: https://docs.docker.com/get-docker/
-2. Open the Docker App on your machine. Verify with `docker info`.
-3. Use node v20 with `nvm use 20`.
-4. Run the following in the root of the sonata codebase:
-   `npx supabase init`.
-5. Run the starting function
-   `npx supabase start`. This will now have the database live with some production data available to you.
-6. Run
-   `npx supabase status`
-7. Now go to .env file and fill the env variables
+1. Clone the repository:
 
-# DB Issues
+   ```
+   git clone https://github.com/sweetmantech/myco-api.git
+   cd myco-api
+   ```
 
-- If you see any errors happening db related or, need to make DB migrations run the following: `npx supabase db reset`
+2. Install dependencies:
 
-```
-NEXT_PUBLIC_SUPABASE_URL={API URL}
-NEXT_PUBLIC_ANON_KEY={anon key}
-SUPABASE_URL={API URL}
-SUPABASE_KEY={service_role key}
-```
+   ```
+   yarn install
+   ```
 
-## Authors
+3. Set up environment variables:
+   Create a `.env.local` file in the root directory and add the following variables:
 
-- [@sweetmantech](https://github.com/sweetmantech) ([warpcast](https://warpcast.com/sweetman-eth))
-- [@ramiechaarani](https://github.com/ramiechaarani) ([warpcast](https://warpcast.com/ramie/))
+   ```
+   STACK_API_KEY=your_stack_api_key
+   PRIVY_APP_ID=your_privy_app_id
+   PRIVY_APP_SECRET=your_privy_app_secret
+   ```
+
+4. Run the development server:
+
+   ```
+   yarn dev
+   ```
+
+5. Open [http://localhost:3000](http://localhost:3000) in your browser to see the application.
+
+## How myco API Helps Developers 👨‍💻
+
+1. **Simplified Zora Integration**: Access Zora protocol data through easy-to-use REST API endpoints. 🔗
+2. **Profile Information**: Retrieve comprehensive Zora profile data for any address. 👤
+3. **Token and Collection Data**: Easily fetch information about Zora tokens and collections. 🖼️
+4. **Rewards System**: Access and track Zora rewards for different activities. 🏆
+5. **Leaderboard**: Implement gamification features using the built-in leaderboard system. 🏅
+6. **Scoring System**: Utilize the Zora score calculation for user engagement metrics. 📊
+
+## How myco API Helps Creators 🎨
+
+1. **Profile Insights**: Gain valuable insights into your Zora profile, including completeness score and follower metrics. 📈
+2. **Reward Tracking**: Easily monitor your earnings from creator rewards, referrals, and first minter bonuses. 💰
+3. **Collection Management**: Access detailed information about your created collections and their performance. 🗂️
+4. **Engagement Metrics**: Understand your audience better with follower and following scores. 🤝
+5. **Leaderboard Participation**: Increase visibility and engagement by participating in the platform's leaderboard. 🌟
 
-## License
+## API Endpoints 🔌
 
-This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details
+For a complete list of available API endpoints and their usage, please refer to our [API documentation](https://api.myco.wtf).
+
+## Contributing 🤝
+
+We welcome contributions! Please open a pull request to contribute.
+
+## License 📄
+
+This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details.
+
+## Authors ✍️
+
+- [@sweetmantech](https://github.com/sweetmantech) ([warpcast](https://warpcast.com/sweetman-eth))