From d7fecff196af11ba48b9827c275654902d5a4882 Mon Sep 17 00:00:00 2001 From: Rodrigo Luglio Date: Sun, 13 Oct 2024 10:18:42 -0300 Subject: [PATCH] added license and readme --- LICENSE | 21 ++++++++++ README.md | 119 ++++++++++++++++++++++++++++++++++++++++++++---------- 2 files changed, 119 insertions(+), 21 deletions(-) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..8fe5ab8 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2024 RLabs Inc. + +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 90f181f..4906e78 100644 --- a/README.md +++ b/README.md @@ -1,34 +1,111 @@ -This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/create-next-app). +# VSCode Theme Generator + +This is a intuitive VSCode themes generator that allows users to create, customize, share and discover color themes for Visual Studio Code. It uniquely incorporates **sacred geometry patterns** for color generation, offering a fresh approach to theme creation. + +## Features + +- **Interactive Theme Creation**: Easily generate themes with a user-friendly interface. +- **Sacred Geometry Color Schemes**: Utilize patterns inspired by sacred geometry for unique and harmonious color combinations. +- **Real-time Preview**: See your changes instantly as you customize your theme. +- **Syntax Highlighting**: Preview your theme with actual code samples. +- **Save and Share**: Store your favorite themes and share them with the community. +- **Export Options**: Download your theme ready to install in VSCode or even publish to the marketplace. +- **Dark/Light Mode**: Toggle between dark and light modes for comfortable theme creation. + +## Sacred Geometry in Color Generation + +Unlike traditional color theory schemes, VSCode Theme Generator employs sacred geometry patterns for color generation. This approach offers several unique benefits: + +- **Harmonic Ratios**: Colors are selected based on proportions found in nature and sacred architecture, resulting in visually pleasing and balanced themes. +- **Unique Combinations**: The use of geometric patterns allows for unexpected yet harmonious color pairings. +- **Customizable Complexity**: Users can choose from various sacred geometry patterns, each offering different levels of color complexity. + +Some of the patterns are: + +- Fibonacci Spiral +- Golden Ratio +- Flower of Life +- Seed of Life +- Vesica Piscis +- Metatron's Cube +- Mandelbrot Set +- Pentagram +- Golden Spiral +- Golden Trisection +- Continued Fraction +- Farey Sequence +- Noble Numbers +- Metallic Means +- And many more... + +These patterns inform the selection and relationship between colors in the generated themes, providing a fresh perspective on color harmony in design. ## Getting Started -First, run the development server: +### Prerequisites + +- Node.js (v18 or later) +- Bun (latest version) + +### Installation + +1. Clone the repository: + + ```sh + git clone https://github.com/yourusername/theme-generator.git + ``` + +2. Navigate to the project directory: + + ```sh + cd theme-generator + ``` + +3. Install dependencies: + + ```sh + bun install + ``` + +4. Set up environment variables: + + - Copy `.env.example` to `.env.local` + - Fill in the required values + +5. Run the development server: + + ```sh + bun run dev + ``` + +6. Open [http://localhost:3000](http://localhost:3000) in your browser to see the application. + +## Technologies Used + +- [Next.js](https://nextjs.org/) (v14 RC) +- [React](https://reactjs.org/) (v19) +- [Tailwind CSS](https://tailwindcss.com/) +- [Shadcn UI](https://ui.shadcn.com/) +- [Drizzle ORM](https://orm.drizzle.team/) +- [Clerk](https://clerk.dev/) for authentication +- [Vercel Postgres](https://vercel.com/storage/postgres) -```bash -npm run dev -# or -yarn dev -# or -pnpm dev -# or -bun dev -``` +## Contributing -Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. +We welcome contributions! -You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file. +## License -## Learn More +This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. -To learn more about Next.js, take a look at the following resources: +## Acknowledgments -- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API. -- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial. +- Special thanks to the open-source community for the amazing tools and libraries that made this project possible. -You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome! +## Contact -## Deploy on Vercel +For any questions or feedback, please open an issue on this repository. -The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js. +--- -Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details. +**Enjoy creating and using themes made with Sacred Geometry!** 🎨✨🔯