diff --git a/README.md b/README.md index 0036e64..8c6db83 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,141 @@ -
+```
+skills-getting-started-with-github-copilot/
+├── src/
+│ ├── app.py # FastAPI application with API endpoints
+│ ├── static/
+│ │ ├── index.html # Web interface
+│ │ ├── app.js # Frontend JavaScript
+│ │ └── styles.css # Styling
+│ └── README.md # Additional documentation
+├── tests/
+│ └── test_app.py # Test suite
+├── requirements.txt # Python dependencies
+├── pytest.ini # Pytest configuration
+└── README.md # This file
+```
-### 🌟 You've successfully completed the exercise! 🌟
+## Available Activities
-## 🚀 Share Your Success!
+The application includes the following extracurricular activities:
-**Show off your new skills and inspire others!**
+- **Academic**: Chess Club, Programming Class, Math Olympiad, Science Club
+- **Sports**: Gym Class, Soccer Team, Basketball Club
+- **Arts**: Drama Club, Art Workshop
+
+Each activity has:
+- Description
+- Schedule
+- Maximum participant capacity
+- List of registered participants
+
+## Testing
+
+Run the test suite using pytest:
+
+```bash
+pytest
+```
+
+The test suite includes:
+- Activity listing tests
+- Signup and unregister flow tests
+- Duplicate signup prevention tests
+- Error handling tests
+- Redirect tests
+
+## Data Storage
+
+The application uses in-memory storage for simplicity. All data (activities and registrations) will be reset when the server restarts. This is suitable for development and learning purposes.
+
+## License
+
+This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
+
+---
+
+
+
+**This project was created as part of the "Getting Started with GitHub Copilot" exercise.**
+
+### 🚀 Share Your Success!