|
| 1 | +# Tinystruct Framework |
| 2 | + |
| 3 | +`"How many are your works, O LORD! In wisdom you made them all; the earth is full of your creatures."` |
| 4 | +***Psalms 104:24*** |
| 5 | + |
| 6 | +## Overview |
| 7 | + |
| 8 | +Tinystruct is a simple yet powerful framework for Java development. It embraces simple thinking and better design principles, making it easy to use while delivering excellent performance. |
| 9 | + |
| 10 | +## Key Features |
| 11 | + |
| 12 | +- **Lightweight Architecture**: Minimal overhead with maximum flexibility |
| 13 | +- **Dual-Mode Support**: Build both web applications and CLI tools |
| 14 | +- **Simple Configuration**: Easy to set up and customize |
| 15 | +- **High Performance**: Optimized for efficient execution |
| 16 | +- **Database Integration**: Built-in support for multiple databases |
| 17 | +- **RESTful Support**: Easy API development |
| 18 | +- **Command Line Tools**: Powerful CLI capabilities |
| 19 | + |
| 20 | +## Quick Start |
| 21 | + |
| 22 | +### Maven Integration |
| 23 | + |
| 24 | +Add the dependency to your pom.xml: |
| 25 | + |
| 26 | +```xml |
| 27 | +<dependency> |
| 28 | + <groupId>org.tinystruct</groupId> |
| 29 | + <artifactId>tinystruct</artifactId> |
| 30 | + <version>1.6.3</version> |
| 31 | + <classifier>jar-with-dependencies</classifier> |
| 32 | +</dependency> |
| 33 | +``` |
| 34 | + |
| 35 | +### Basic Application Example |
| 36 | + |
| 37 | +```java |
| 38 | +package tinystruct.examples; |
| 39 | + |
| 40 | +import org.tinystruct.AbstractApplication; |
| 41 | +import org.tinystruct.ApplicationException; |
| 42 | +import org.tinystruct.system.annotation.Action; |
| 43 | + |
| 44 | +public class Example extends AbstractApplication { |
| 45 | + |
| 46 | + @Override |
| 47 | + public void init() { |
| 48 | + // Initialization code |
| 49 | + } |
| 50 | + |
| 51 | + @Action("praise") |
| 52 | + public String praise() { |
| 53 | + return "Praise the Lord!"; |
| 54 | + } |
| 55 | + |
| 56 | + @Action("say") |
| 57 | + public String say(String words) { |
| 58 | + return words; |
| 59 | + } |
| 60 | +} |
| 61 | +``` |
| 62 | + |
| 63 | +## Documentation Contents |
| 64 | + |
| 65 | +- [Getting Started](getting-started.md) |
| 66 | +- [Core Concepts](core-concepts.md) |
| 67 | +- [Web Applications](web-applications.md) |
| 68 | +- [CLI Applications](cli-applications.md) |
| 69 | +- [Configuration](configuration.md) |
| 70 | +- [Database Integration](database.md) |
| 71 | +- [Advanced Features](advanced-features.md) |
| 72 | +- [Best Practices](best-practices.md) |
| 73 | +- [API Reference](api/README.md) |
| 74 | + |
| 75 | +## Community and Support |
| 76 | + |
| 77 | +- GitHub Repository: [https://github.com/tinystruct/tinystruct](https://github.com/tinystruct/tinystruct) |
| 78 | +- Issue Tracker: [https://github.com/tinystruct/tinystruct/issues](https://github.com/tinystruct/tinystruct/issues) |
| 79 | +- Discussion Forum: [https://github.com/tinystruct/tinystruct/discussions](https://github.com/tinystruct/tinystruct/discussions) |
| 80 | + |
| 81 | +## License |
| 82 | + |
| 83 | +Licensed under the Apache License, Version 2.0 |
0 commit comments