From ba8cd1223374bc0a77cc1bb40acfe4db0bfc38be Mon Sep 17 00:00:00 2001 From: Roland Tritsch Date: Fri, 19 Dec 2025 17:54:18 +0000 Subject: [PATCH] Add LICENSE file Co-authored-by: Roland Tritsch --- LICENSE | 21 +++++++++++++++++++++ README.md | 19 +++++++++++++------ 2 files changed, 34 insertions(+), 6 deletions(-) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 00000000..7cbc4d46 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2025 github.com/zli484 + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md index c6a264d4..3466e5c8 100644 --- a/README.md +++ b/README.md @@ -118,7 +118,7 @@ pnpm prisma db seed ### 5. Supabase Setup -1. Create a new Supabase project at [supabase.com](https://supabase.com) +1. Create a new Supabase project at [supabase.com][] 2. Go to **Settings > API** and copy: - Project URL โ†’ `NEXT_PUBLIC_SUPABASE_URL` - Anon public key โ†’ `NEXT_PUBLIC_SUPABASE_ANON_KEY` @@ -127,14 +127,14 @@ pnpm prisma db seed ### 6. OpenAI Setup -1. Create an account at [platform.openai.com](https://platform.openai.com) +1. Create an account at [platform.openai.com][] 2. Generate an API key in **API Keys** section 3. Add credits to your account 4. Copy the API key to `OPENAI_API_KEY` ### 7. LlamaCloud Setup (Optional) -1. Create an account at [cloud.llamaindex.ai](https://cloud.llamaindex.ai) +1. Create an account at [cloud.llamaindex.ai][] 2. Create a new project 3. Generate an API key 4. Copy the API key to `LLAMACLOUD_API_KEY` @@ -145,7 +145,7 @@ pnpm prisma db seed pnpm dev ``` -Visit [http://localhost:3000](http://localhost:3000) to see the application. +Visit [http://localhost:3000][] to see the application. ## ๐Ÿ“ Project Structure @@ -262,7 +262,7 @@ The application can be deployed to any platform that supports Node.js: ## ๐Ÿงช Sample Data Try the platform with our sample RFP document: -- **Sample File**: [RFP - Launch Services for Medium-Lift Payloads](https://qluspotebpidccpfbdho.supabase.co/storage/v1/object/public/sample-files//RFP%20-%20Launch%20Services%20for%20Medium-Lift%20Payloads.pdf) +- **Sample File**: [RFP - Launch Services for Medium-Lift Payloads][rfp-sample-file] - **Use Case**: Download and upload to test question extraction and response generation ## ๐Ÿ› Troubleshooting @@ -331,7 +331,7 @@ pnpm lint ## ๐Ÿ“„ License -This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. +This project is licensed under the MIT License - see the [LICENSE][] file for details. ## ๐Ÿ™ Acknowledgments @@ -350,3 +350,10 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file --- Built with โค๏ธ using Next.js, LlamaIndex, and OpenAI + +[LICENSE]: ./LICENSE +[cloud.llamaindex.ai]: https://cloud.llamaindex.ai +[http://localhost:3000]: http://localhost:3000 +[platform.openai.com]: https://platform.openai.com +[rfp-sample-file]: https://qluspotebpidccpfbdho.supabase.co/storage/v1/object/public/sample-files//RFP%20-%20Launch%20Services%20for%20Medium-Lift%20Payloads.pdf +[supabase.com]: https://supabase.com