docs: improve README, add .gitignore, rename .env to .env.example#1
Merged
LUKSOAgent merged 2 commits intomainfrom Mar 5, 2026
Merged
docs: improve README, add .gitignore, rename .env to .env.example#1LUKSOAgent merged 2 commits intomainfrom
LUKSOAgent merged 2 commits intomainfrom
Conversation
- Add comprehensive root README.md: project overview, monorepo structure, deployed contract addresses, full run-locally instructions for frontend/ backend/contracts/agent-sdk, env variable reference table, tech stack - Add root .gitignore: covers node_modules, .env files, build outputs, Foundry artifacts, logs, OS/editor files - Rename frontend/.env → frontend/.env.example with placeholder API key (removes real NFT.Storage key from version control) - .env files are now excluded from git via .gitignore
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What this PR does
📖 Root
README.md(new file)The repo had no README. Added a comprehensive one covering:
frontend/,backend/,contracts/,agent-sdk/)🔒 Root
.gitignore(new file)The repo had no
.gitignoreat the root. Added coverage for:node_modules/(all levels).envand.env.*.local— secrets never committeddist/,build/,out/)contracts/out/,contracts/cache/)🔑
frontend/.env→frontend/.env.examplefrontend/.env.env.examplewith a placeholder value (your_nft_storage_api_key_here).envis now covered by.gitignoregoing forwardcp .env.example .envand fill in their own key