From 72e05b91f0c5be8ce2b721d357225eaabb17edca Mon Sep 17 00:00:00 2001 From: Aditya Oberai Date: Mon, 25 Sep 2023 17:25:29 +0530 Subject: [PATCH 1/3] Create repo readme --- README.md | 49 ++++++++++++++++++++++++++----------------------- 1 file changed, 26 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index 5c91169b0c..514da239be 100644 --- a/README.md +++ b/README.md @@ -1,38 +1,41 @@ -# create-svelte +# Website 🖥️ -Everything you need to build a Svelte project, powered by [`create-svelte`](https://github.com/sveltejs/kit/tree/master/packages/create-svelte). +[![Discord](https://img.shields.io/discord/564160730845151244?label=discord&style=flat-square)](https://appwrite.io/discord) +[![Twitter Account](https://img.shields.io/twitter/follow/appwrite?color=00acee&label=twitter&style=flat-square)](https://twitter.com/appwrite) +[![appwrite.io](https://img.shields.io/badge/appwrite-.io-f02e65?style=flat-square)](https://appwrite.io) -## Creating a project +The Appwrite Website repo features the main Appwrite website, including our [homepage](https://appwrite.io), [docs](https://appwrite.io/docs), and upcoming blog. -If you're seeing this, you've probably already done this step. Congrats! +The Appwrite Website has been built with the following frameworks: -```bash -# create a new project in the current directory -npm create svelte@latest +- [Svelte](https://svelte.dev/) +- [SvelteKit](https://kit.svelte.dev/) + +## Development + +*If this is your first time setting up the repository, please run `pnpm install` inside the repo's directory.* -# create a new project in my-app -npm create svelte@latest my-app +To get the repo up and running in your local environment, use the following command: +```bash +pnpm run dev ``` -## Developing +> If you don't have `pnpm` available on your system, you can install it from the [official pnpm Installation website](https://pnpm.io/installation) -Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server: +## Contributing -```bash -npm run dev +All code contributions, including those of people with commit access, must go through a pull request and be approved by a core developer before being merged. This is to ensure a proper review of all the code. -# or start the server and open the app in a new browser tab -npm run dev -- --open -``` +We truly ❤️ pull requests! If you wish to help, you can learn more about how you can contribute to this project in the [contribution guide](./CONTRIBUTING.md). -## Building +## Security -To create a production version of your app: +For security issues, kindly email us at [security@appwrite.io](mailto:security@appwrite.io) instead of posting a public issue on GitHub. -```bash -npm run build -``` +## Follow Us + +Join our growing community around the world! See our official [Blog](https://medium.com/appwrite-io). Follow us on [Twitter](https://twitter.com/appwrite), [Facebook Page](https://www.facebook.com/appwrite.io), [Facebook Group](https://www.facebook.com/groups/appwrite.developers/), and [Dev Community](https://dev.to/appwrite) or join our live [Discord server](https://appwrite.io/discord) for more help, ideas, and discussions. -You can preview the production build with `npm run preview`. +## License -> To deploy your app, you may need to install an [adapter](https://kit.svelte.dev/docs/adapters) for your target environment. +This repository is available under the [BSD 3-Clause License](./LICENSE). From 8618f65111a169fbe9bb3abdfd55eebf5fb35da8 Mon Sep 17 00:00:00 2001 From: Aditya Oberai Date: Mon, 25 Sep 2023 17:31:48 +0530 Subject: [PATCH 2/3] Add cover banner We can update this later if need be --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 514da239be..911e1106df 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,8 @@ [![Twitter Account](https://img.shields.io/twitter/follow/appwrite?color=00acee&label=twitter&style=flat-square)](https://twitter.com/appwrite) [![appwrite.io](https://img.shields.io/badge/appwrite-.io-f02e65?style=flat-square)](https://appwrite.io) +![Cover banner](https://github.com/appwrite/website/assets/31401437/0852817d-b482-4e06-a002-ee84b2a7052c) + The Appwrite Website repo features the main Appwrite website, including our [homepage](https://appwrite.io), [docs](https://appwrite.io/docs), and upcoming blog. The Appwrite Website has been built with the following frameworks: From 6148c6b7e8d828faa65b5097b45ff2dfd7b3a885 Mon Sep 17 00:00:00 2001 From: Aditya Oberai Date: Mon, 25 Sep 2023 23:25:00 +0530 Subject: [PATCH 3/3] Create LICENSE --- LICENSE | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000000..8d077191cc --- /dev/null +++ b/LICENSE @@ -0,0 +1,28 @@ +BSD 3-Clause License + +Copyright (c) 2023, Appwrite + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + +1. Redistributions of source code must retain the above copyright notice, this + list of conditions and the following disclaimer. + +2. Redistributions in binary form must reproduce the above copyright notice, + this list of conditions and the following disclaimer in the documentation + and/or other materials provided with the distribution. + +3. Neither the name of the copyright holder nor the names of its + contributors may be used to endorse or promote products derived from + this software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE +FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR +SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER +CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, +OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.