Missing Project Documentation #13
Description
Problem
The project currently lacks comprehensive documentation, making it difficult for:
- New developers to understand and contribute to the project
- Users to set up and use the Akave Testnet Faucet
- Team members to understand the project structure and development workflow
Current State
- README.md is minimal with only the project title
- No setup instructions are available
- Missing documentation about project structure and features
- No contributing guidelines
Solution
Add a comprehensive README.md that includes:
- Project overview and features
- Setup and installation instructions
- Development workflow documentation
- Project structure breakdown
- Available scripts documentation
- Technology stack details
- Contributing guidelines