|
1 | | - |
2 | | -<!--  --> |
3 | | - |
4 | | - |
5 | | - |
6 | | - |
7 | | - |
8 | | -# `gofannon` |
9 | | - |
10 | | -**[gofannon](https://the-ai-alliance.github.io/gofannon/)** is now a web app that helps subject matter experts rapidly prototype AI agents and the web UIs that wrap them. Build flows, preview interactions, and share working agent-driven experiences without having to become a framework specialist. |
11 | | - |
12 | | -Professional support and advisory services are available from **AtA Systems**—learn more at [ramenata.ai](https://ramenata.ai). |
13 | | - |
14 | | -## 🌟🌟 What you can do 🌟🌟 |
15 | | -1. **Prototype agents fast** |
16 | | - - Compose tools, data sources, and decision paths through a guided interface. |
17 | | - - Preview responses and iterate with real-time feedback. |
18 | | -2. **Design lightweight web UIs** |
19 | | - - Pair your agents with forms, chat surfaces, and dashboards to validate user journeys quickly. |
20 | | - - Export or embed prototypes to share with stakeholders. |
21 | | -3. **Stay flexible** |
22 | | - - Keep using your preferred AI stack—gofannon focuses on prototyping and handoff, not lock-in. |
23 | | -4. **Get expert help when you need it** |
24 | | - - AtA Systems offers professional support, integration help, and custom extensions for teams building on gofannon. |
25 | | - |
26 | | -## 🎓🎓 Why the name `gofannon`? 🎓🎓 |
27 | | - |
28 | | -See [`why_the_name_gofannon`](https://the-ai-alliance.github.io/gofannon/about/the_name_gofannon/) for the rich story on why we chose to honor this Celtic Diety |
29 | | - |
30 | | -## ⚡️⚡️Quickstart ⚡️⚡️ |
31 | | - |
32 | | -```bash |
| 1 | +<p align="center"> |
| 2 | + <img src="https://raw.githubusercontent.com/The-AI-Alliance/gofannon/main/website/static/img/logo_1000x1260.png" alt="Gofannon" width="200"> |
| 3 | +</p> |
| 4 | + |
| 5 | +# Gofannon |
| 6 | + |
| 7 | +[](https://pypi.org/project/gofannon/) |
| 8 | +[](LICENSE) |
| 9 | +[](https://github.com/The-AI-Alliance/gofannon/issues) |
| 10 | + |
| 11 | +Gofannon is a provider- and model-agnostic toolkit and web application for prototyping AI agents and the lightweight web UIs that wrap them. Subject matter experts compose tools, data sources, and decision paths through a guided interface, preview agent interactions in real time, and hand off working agent-driven experiences without committing to a single AI framework or model provider. |
| 12 | + |
| 13 | +## What you can do |
| 14 | + |
| 15 | +- **Prototype agents quickly.** Compose tools, data sources, and decision paths through a guided interface, and iterate with real-time feedback. |
| 16 | +- **Design lightweight web UIs.** Pair agents with forms, chat surfaces, and dashboards to validate user journeys; export or embed prototypes to share with stakeholders. |
| 17 | +- **Stay flexible.** Gofannon supports multiple model providers (OpenAI, Anthropic, Gemini, and others via LiteLLM) and is designed to keep your work portable across them. |
| 18 | + |
| 19 | +## Quickstart |
| 20 | + |
| 21 | +```bash |
33 | 22 | git clone https://github.com/The-AI-Alliance/gofannon.git |
34 | 23 | cd gofannon/webapp/infra/docker |
35 | 24 | docker-compose up --build |
36 | 25 | ``` |
37 | | -For more information, see our [quickstart guide](https://github.com/The-AI-Alliance/gofannon/blob/main/docs/quickstart/README.md). |
38 | 26 |
|
39 | | -## 🏆🏆 Acknowledgments 🏆🏆 |
| 27 | +See the [quickstart guide](docs/quickstart/README.md) for details, including required environment configuration. |
| 28 | + |
| 29 | +## Documentation |
40 | 30 |
|
41 | | -We would like to thank the open-source community for their contributions and support in making this project possible. |
| 31 | +Full documentation lives in [`docs/`](docs/) and is published at <https://the-ai-alliance.github.io/gofannon/>. Highlights: |
42 | 32 |
|
43 | | -<a href="https://github.com/The-AI-Alliance/gofannon/graphs/contributors"> |
44 | | - <img src="https://contrib.rocks/image?repo=The-AI-Alliance/gofannon" /> |
45 | | -</a> |
| 33 | +- [Quickstart](docs/quickstart/README.md) |
| 34 | +- [Developer quickstart](docs/developers-quickstart.md) |
| 35 | +- [API reference](docs/api.md) |
| 36 | +- [LLM provider configuration](docs/llm-provider-configuration.md) |
| 37 | +- [Testing](docs/testing/README.md) |
46 | 38 |
|
47 | | -Made with [contrib.rocks](https://contrib.rocks). |
| 39 | +## About the name |
48 | 40 |
|
49 | | -## 🗞️🗞️ Stay Up To Date 🗞️🗞️ |
| 41 | +Gofannon is the Welsh god of smithcraft. See [About the name](docs/about-name-origin.md) for the story behind the choice. |
50 | 42 |
|
51 | | -Star `gofannon` for good karma (and to receive updates in your github feed). |
| 43 | +## Roadmap |
52 | 44 |
|
53 | | - |
| 45 | +Planned features and their current status are tracked in [ROADMAP.md](ROADMAP.md). |
54 | 46 |
|
55 | | -## 🚲🚲 Roadmap 🚲🚲 |
56 | | - |
57 | | -For a detailed overview of planned features and their current status, please refer to the [ROADMAP](https://github.com/The-AI-Alliance/gofannon/blob/main/ROADMAP.md). |
| 47 | +## Community |
58 | 48 |
|
59 | | -## 📘📘 Documentation 📘📘 |
| 49 | +- Report bugs or request features in [GitHub Issues](https://github.com/The-AI-Alliance/gofannon/issues). |
| 50 | +- Ask questions and discuss ideas in [GitHub Discussions](https://github.com/The-AI-Alliance/gofannon/discussions). |
60 | 51 |
|
61 | | -Documentation can be found [here](https://github.com/The-AI-Alliance/gofannon/tree/main/docs). Each tool comes with its own documentation, which can be found in the docs/ directory. The documentation provides detailed information on how to use each tool, including required parameters and example usage. |
| 52 | +## Contributing |
62 | 53 |
|
63 | | -### Testing Documentation |
| 54 | +Contributions are welcome. See [CONTRIBUTING.md](CONTRIBUTING.md) for how to get started, including the "good first issue" label for newcomers and contribution guides for adding tools, integrating new agentic frameworks, and extending the web UI. |
64 | 55 |
|
65 | | -For information about running tests and contributing code with tests, see the [Testing Documentation](https://github.com/The-AI-Alliance/gofannon/tree/main/docs/testing): |
66 | | -- [Testing Overview](https://github.com/The-AI-Alliance/gofannon/blob/main/docs/testing/README.md) - Quick start and testing strategy |
67 | | -- [Unit Testing Guide](https://github.com/The-AI-Alliance/gofannon/blob/main/docs/testing/unit-testing.md) - How to write unit tests |
68 | | -- [Contributing Tests](https://github.com/The-AI-Alliance/gofannon/blob/main/docs/testing/contributing.md) - PR requirements |
| 56 | +## Acknowledgments |
69 | 57 |
|
70 | | -## ☎️☎️ Contact Us ☎️☎️ |
| 58 | +Thanks to the open-source community for contributions and support that have made this project possible. |
71 | 59 |
|
72 | | -[Contact Information](https://the-ai-alliance.github.io/gofannon/community/contact.html) |
| 60 | +[](https://github.com/The-AI-Alliance/gofannon/graphs/contributors) |
73 | 61 |
|
74 | | -## 🧑⚖️🧑⚖️ License 🧑⚖️🧑⚖️ |
75 | | - |
76 | | -This project is licensed under the ASFv2 License. See the [LICENSE](https://github.com/The-AI-Alliance/gofannon/blob/main/LICENSE) file for more details. |
| 62 | +## License |
77 | 63 |
|
78 | | - |
79 | | - |
| 64 | +Gofannon is licensed under the Apache License, Version 2.0. See [LICENSE](LICENSE) for the full text. |
0 commit comments