diff --git a/.vscode/settings.json b/.vscode/settings.json index badaac05..34584f3c 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -10,5 +10,5 @@ "url": "https://json.schemastore.org/electron-builder" } ], - "github.copilot.inlineSuggest.enable": true + "github.copilot.inlineSuggest.enable": false } \ No newline at end of file diff --git a/README.md b/README.md index caf33255..5c7508ea 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,184 @@ -# Onlook - The first devtool for designer -![Preview screenshot](public/Screenshot.png) + + + + + + +[![Contributors][contributors-shield]][contributors-url] +[![Forks][forks-shield]][forks-url] +[![Stargazers][stars-shield]][stars-url] +[![Issues][issues-shield]][issues-url] +[![Apache License][license-shield]][license-url] +[![LinkedIn][linkedin-shield]][linkedin-url] +[![Twitter][twitter-shield]][twitter-url] + + + +
+
+ + Logo + + +

Onlook

+ +

+ The first browser-powered visual editor. +
+ Explore the docs » +
+
+ View Demo + · + Report Bug + · + Request Feature +

+
+ + +
+ Table of Contents +
    +
  1. + About The Project + +
    2. +
  2. Installation
    3. +
  3. Usage
    4. +
  4. Roadmap
    5. +
  5. Contributing
    6. +
  6. License
    7. +
  7. Contact
    8. +
  8. Acknowledgments
    9. +
+
+ +## About The Project + +[![Onlook Screen Shot][product-screenshot]](https://onlook.dev) + +Onlook lets you edit any web page. And then publish your changes to GitHub without writing any code yourself! + +### Built With +* [![React][React.js]][React-url] +* [![Electron][Electron.js]][Electron-url] +* [![Tailwind][TailwindCSS]][Tailwind-url] +* [![Vite][Vite.js]][Vite-url] + + +### Installation + +1. Clone the repo + ```sh + git clone https://github.com/onlook-dev/studio.git + ``` +2. Install NPM packages + ```sh + npm install + ``` +3. Run the project + ```js + npm run dev + ``` + + +## Usage + +Coming soon... you'll be able to download the app. + +_For more examples, please refer to the [Documentation](https://onlook.dev)_ + + + +## Roadmap + +* [X] Browser +* [ ] Editor +* [ ] Write-to-code +* [ ] Components +* [ ] Variables +* [ ] Code Editor + +See the [open issues](https://github.com/onlook-dev/studio/issues) for a full list of proposed features (and known issues). + + +## Contributing + +Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**. + +If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". +Don't forget to give the project a star! Thanks again! + +1. Fork the Project +2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`) +3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`) +4. Push to the Branch (`git push origin feature/AmazingFeature`) +5. Open a Pull Request + + +## License + +Distributed under the Apache 2.0 License. See `LICENSE.txt` for more information. + +## Contact + +Onlook Team - [@onlookdev](https://twitter.com/onlookdev) - contact@onlook.com + +Project Link: [https://github.com/onlook-dev/studio](https://github.com/onlook-dev/studio) + +Website: [https://onlook.dev](https://onlook.dev) + +## Acknowledgments + +[Project Visbug](https://github.com/GoogleChromeLabs/ProjectVisBug) + +[Responsively App](https://github.com/responsively-org/responsively-app) + + + + +[contributors-shield]: https://img.shields.io/github/contributors/onlook-dev/studio.svg?style=for-the-badge +[contributors-url]: https://github.com/onlook-dev/studio/graphs/contributors + +[forks-shield]: https://img.shields.io/github/forks/onlook-dev/studio.svg?style=for-the-badge +[forks-url]: https://github.com/onlook-dev/studio/network/members + +[stars-shield]: https://img.shields.io/github/stars/onlook-dev/studio.svg?style=for-the-badge +[stars-url]: https://github.com/onlook-dev/studio/stargazers + +[issues-shield]: https://img.shields.io/github/issues/onlook-dev/studio.svg?style=for-the-badge +[issues-url]: https://github.com/onlook-dev/studio/issues + +[license-shield]: https://img.shields.io/github/license/onlook-dev/studio.svg?style=for-the-badge +[license-url]: https://github.com/onlook-dev/studio/blob/master/LICENSE.txt + +[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555 +[linkedin-url]: https://www.linkedin.com/company/onlook-dev + +[twitter-shield]: https://img.shields.io/badge/-Twitter-black?style=for-the-badge&logo=twitter&colorB=555 +[twitter-url]: https://x.com/onlookdev + +[React.js]: https://img.shields.io/badge/react-%2320232a.svg?style=for-the-badge&logo=react&logoColor=%2361DAFB +[React-url]: https://reactjs.org/ + +[TailwindCSS]: https://img.shields.io/badge/tailwindcss-%2338B2AC.svg?style=for-the-badge&logo=tailwind-css&logoColor=white +[Tailwind-url]: https://tailwindcss.com/ + +[Electron.js]: https://img.shields.io/badge/Electron-191970?style=for-the-badge&logo=Electron&logoColor=white +[Electron-url]: https://www.electronjs.org/ + +[Vite.js]: https://img.shields.io/badge/vite-%23646CFF.svg?style=for-the-badge&logo=vite&logoColor=white +[Vite-url]: https://vitejs.dev/ + +[product-screenshot]: public/screenshot.png -## About -More coming soon [@Onlook](https://onlook.dev/) diff --git a/public/Screenshot.png b/public/Screenshot.png index 61de1265..06442015 100644 Binary files a/public/Screenshot.png and b/public/Screenshot.png differ diff --git a/public/favicon.ico b/public/favicon.ico index 0fc503d1..1b3613cd 100644 Binary files a/public/favicon.ico and b/public/favicon.ico differ diff --git a/public/node.svg b/public/node.svg index 38d4eaaf..f3136590 100644 --- a/public/node.svg +++ b/public/node.svg @@ -1 +1,28 @@ - \ No newline at end of file + + + + + + + + + + + + + + + + + + + + + + + + + + + +