Feat: Add comprehensive project documentation

.eslintrc.json

@@ -0,0 +1,24 @@
+{
+  "extends": [
+    "next/core-web-vitals",
+    "plugin:@typescript-eslint/recommended",
+    "plugin:react/recommended",
+    "plugin:react-hooks/recommended",
+    "prettier"
+  ],
+  "plugins": ["@typescript-eslint", "react", "prettier"],
+  "rules": {
+    "prettier/prettier": ["error"],
+    "react/react-in-jsx-scope": "off",
+    "react/prop-types": "off",
+    "@typescript-eslint/explicit-module-boundary-types": "off",
+    "@typescript-eslint/no-unused-vars": ["warn"],
+    "@typescript-eslint/no-explicit-any": "warn",
+    "no-console": ["warn", { "allow": ["warn", "error"] }]
+  },
+  "settings": {
+    "react": {
+      "version": "detect"
+    }
+  }
+}

.prettierrc

@@ -0,0 +1,11 @@
+{
+  "semi": false,
+  "singleQuote": true,
+  "tabWidth": 2,
+  "trailingComma": "es5",
+  "printWidth": 100,
+  "bracketSpacing": true,
+  "arrowParens": "always",
+  "endOfLine": "lf",
+  "plugins": ["prettier-plugin-tailwindcss"]
+}

README.md

@@ -1 +1,94 @@
-# akave-testnet-faucet
+# Akave Testnet Faucet
+
+A modern, user-friendly faucet application for the Akave testnet built with Next.js and TypeScript.
+
+## Features
+
+- 🚀 Built with Next.js 15 and React 19
+- 💎 TypeScript for type safety
+- 🎨 Modern UI with TailwindCSS
+- ⛓️ Blockchain interaction using Viem
+- 🔔 Toast notifications for better UX
+- 🛠️ Development tools including ESLint, Prettier, and Husky
+
+## Prerequisites
+
+- Node.js 18.x or later
+- npm or yarn package manager
+
+## Getting Started
+
+1. Clone the repository:
+```bash
+git clone <repository-url>
+cd akave-faucet
+```
+
+2. Install dependencies:
+```bash
+npm install
+# or
+yarn install
+```
+
+3. Run the development server:
+```bash
+npm run dev
+# or
+yarn dev
+```
+
+Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
+
+## Available Scripts
+
+- `npm run dev` - Start development server
+- `npm run build` - Build production bundle
+- `npm run start` - Start production server
+- `npm run lint` - Run ESLint
+- `npm run format` - Format code with Prettier
+- `npm run format:check` - Check code formatting
+
+## Project Structure
+
+```
+akave-faucet/
+├── app/                # Next.js app directory
+│   ├── api/           # API routes
+│   ├── fonts/         # Font assets
+│   ├── page.tsx       # Main page component
+│   ├── layout.tsx     # Root layout
+│   └── globals.css    # Global styles
+├── public/            # Static assets
+└── ...config files    # Various configuration files
+```
+
+## Technologies
+
+- [Next.js](https://nextjs.org/) - React framework
+- [React](https://react.dev/) - UI library
+- [TypeScript](https://www.typescriptlang.org/) - Type safety
+- [TailwindCSS](https://tailwindcss.com/) - Styling
+- [Viem](https://viem.sh/) - Ethereum interactions
+- [React Hot Toast](https://react-hot-toast.com/) - Toast notifications
+
+## Development
+
+The project uses several development tools to ensure code quality:
+
+- ESLint for code linting
+- Prettier for code formatting
+- Husky for git hooks
+- TypeScript for static type checking
+
+## License
+
+This project is licensed under the terms of the license included in the repository.
+
+## Contributing
+
+1. Fork the repository
+2. Create your feature branch (`git checkout -b feature/amazing-feature`)
+3. Commit your changes (`git commit -m 'Add some amazing feature'`)
+4. Push to the branch (`git push origin feature/amazing-feature`)
+5. Open a Pull Request

package.json

@@ -6,7 +6,9 @@
     "dev": "next dev",
     "build": "next build",
     "start": "next start",
-    "lint": "next lint"
+    "lint": "next lint",
+    "format": "prettier --write .",
+    "format:check": "prettier --check ."
   },
   "dependencies": {
     "next": "15.0.1",
@@ -19,7 +21,18 @@
     "@types/node": "^20",
     "@types/react": "^18",
     "@types/react-dom": "^18",
+    "@typescript-eslint/eslint-plugin": "^8.26.1",
+    "@typescript-eslint/parser": "^8.26.1",
+    "eslint-config-prettier": "^10.1.1",
+    "eslint-plugin-import": "^2.31.0",
+    "eslint-plugin-prettier": "^5.2.3",
+    "eslint-plugin-react": "^7.37.4",
+    "eslint-plugin-react-hooks": "^5.2.0",
+    "husky": "^9.1.7",
+    "lint-staged": "^15.5.0",
     "postcss": "^8",
+    "prettier": "^3.5.3",
+    "prettier-plugin-tailwindcss": "^0.6.11",
     "tailwindcss": "^3.4.1",
     "typescript": "^5"
   }