feat: added readme and translation

eser · Jul 3, 2023 · 39da124 · 39da124
1 parent 844f42b
commit 39da124
Show file tree

Hide file tree

Showing 4 changed files with 99 additions and 53 deletions.
diff --git a/README.en.md b/README.en.md
@@ -0,0 +1,37 @@
+# Aya - Open Source Network
+[![Discord](https://img.shields.io/discord/1072074800622739476?color=7289da&logo=discord&logoColor=white)](https://discord.gg/itdepremyardim)
+![GitHub issues](https://img.shields.io/github/issues/acikkaynak/aya-website)
+
+(For Turkish please click [here](README.md))
+
+We are a close-knit and passionate community of individuals who share a common interest in open source software and open source data. United by our dedication to leveraging technology for the betterment of society, we joined forces following the devastating [February 2023 earthquake](https://en.wikipedia.org/wiki/2023_Turkey%E2%80%93Syria_earthquake) in Turkey.
+
+In the aftermath of the earthquake, we recognized the pressing need to support those affected and assist in the process of reuniting families and loved ones. With this purpose in mind, we set out to develop innovative tools and solutions aimed at facilitating the search and connection between individuals.
+
+Through tireless collaboration and a collective effort, our community has grown to an inspiring size of 24,000 individuals. Together, we continue to refine and expand our tools, harnessing the power of technology to help reunite families, restore hope, and bring solace to those impacted by the earthquake.
+
+As we forge ahead, our commitment remains unwavering. We strive to enhance our tools, actively contribute to open source projects, and foster a supportive environment where knowledge sharing and collaboration thrive. We are proud to be a part of the open source community and look forward to continuing our journey with you.
+
+## Our Mission
+
+We are actively engaged in utilizing open-source solutions, applying information systems, and implementing engineering practices to contribute to the betterment of the society we reside in. Our primary focus lies in fulfilling social responsibility needs and addressing various societal challenges through these means. By leveraging our expertise and resources, we strive to make a positive impact and foster sustainable development within our community.
+
+## Technology
+
+These are the technologies we use to build our projects:
+
+For Web:
+- [Next.js](https://nextjs.org)
+- [Tailwind CSS](https://tailwindcss.com)
+- [Supabase](https://supabase.io)
+- [Vercel](https://vercel.com)
+
+For Backend:
+- [Prisma](https://prisma.io)
+- [Deno](https://deno.land)
+- [Express](https://expressjs.com)
+
+## How to Contribute
+
+We welcome contributions from everyone. If you want to help you can check out our [issues](https://github.com/acikkaynak/aya-website/issues). If you have any questions, feel free to join our [Discord server](https://discord.gg/itdepremyardim). If you are stuck at any point, feel free to ask for help on Github Issues or Discord.
+
diff --git a/README.md b/README.md
@@ -1,67 +1,37 @@
-# next-template
+# Aya - Açık Yazılım Ağı
+[![Discord](https://img.shields.io/discord/1072074800622739476?color=7289da&logo=discord&logoColor=white)](https://discord.gg/itdepremyardim)
+![GitHub issues](https://img.shields.io/github/issues/acikkaynak/aya-website)
 
-A Next.js 13 template for building apps with Radix UI and Tailwind CSS.
 
-## Features
+(For English please click [here](README.en.md))
 
-- Radix UI Primitives
-- Tailwind CSS
-- Icons from [Lucide](https://lucide.dev)
-- Dark mode with `next-themes`
+Açık kaynak yazılımı ve açık kaynak verilerine ortak ilgi duyan bireylerden oluşan sıkı bağlı ve tutkulu bir topluluğuz. Toplumun iyileştirilmesi için teknolojiden yararlanma kararlılığımızla birleşerek, Türkiye'de meydana gelen yıkıcı [Şubat 2023 depremi](https://en.wikipedia.org/wiki/2023_Turkey%E2%80%93Syria_earthquake) sonrasında güçlerimizi birleştirdik.
 
-## Tailwind CSS Features
+Depremin ardından, etkilenenlere destek olma ve aileleri ile sevdiklerini yeniden bir araya getirme sürecine yardım etme acil ihtiyacını fark ettik. Bu amaç doğrultusunda, bireyler arasındaki arama ve bağlantıyı kolaylaştırmayı hedefleyen yenilikçi araçlar ve çözümler geliştirmek için yola çıktık.
 
-- Class merging with `taiwind-merge`
-- Animation with `tailwindcss-animate`
-- Conditional classes with `clsx`
-- Variants with `class-variance-authority`
-- Automatic class sorting with `eslint-plugin-tailwindcss`
+Yorulmak bilmeyen işbirliği ve kolektif çabalar sayesinde topluluğumuz ilham verici bir büyüklüğe ulaştı ve 24.000 kişiden oluşan bir topluluk haline geldik. Birlikte, aileleri yeniden bir araya getirmeye, umudu geri kazandırmaya ve depremden etkilenenlere teselli sunmaya yardımcı olmak için teknolojinin gücünden yararlanarak araçlarımızı sürekli olarak geliştiriyoruz ve genişletiyoruz.
 
-### Input
+İlerlemeye devam ederken, taahhüdümüzden sapmadan devam ediyoruz. Araçlarımızı geliştirmeye, açık kaynak projelere aktif olarak katkıda bulunmaya ve bilgi paylaşımı ve işbirliğinin geliştiği destekleyici bir ortamı teşvik etmeye çalışıyoruz. Açık kaynak topluluğunun bir parçası olmaktan gurur duyuyoruz ve sizlerle olan yolculuğumuza dört gözle devam etmek için sabırsızlanıyoruz.
 
-```tsx
-import * as React from "react";
-import Link from "next/link";
+## Görevimiz
 
-import { siteConfig } from "@/shared/config.ts";
-import { buttonVariants } from "@/shared/components/ui/button.tsx";
-import { twMerge } from "tailwind-merge";
+Açık kaynak çözümlerini kullanarak, bilgi sistemlerini uygulayarak ve mühendislik uygulamalarını hayata geçirerek, içinde yaşadığımız toplumun iyileştirilmesine aktif olarak katkıda bulunmayı hedefliyoruz. Öncelikli odak noktamız, sosyal sorumluluk ihtiyaçlarını karşılamak ve bu yollarla çeşitli toplumsal zorluklarla baş etmektir. Uzmanlığımızı ve kaynaklarımızı kullanarak, topluluğumuz içinde pozitif bir etki yaratmayı ve sürdürülebilir kalkınmayı teşvik etmeyi amaçlıyoruz.
 
-import { cn } from "@/shared/lib/cn.ts";
-```
+## Teknoloji
 
-### Output
+Projelerimizi oluşturmak için kullandığımız teknolojiler şunlardır:
 
-```tsx
-import * as React from "react";
-// React is always first.
-import Link from "next/link";
-// Followed by next modules.
-import { twMerge } from "tailwind-merge";
+Frontend için:
+- [Next.js](https://nextjs.org)
+- [Tailwind CSS](https://tailwindcss.com)
+- [Supabase](https://supabase.io)
+- [Vercel](https://vercel.com)
 
-// Followed by third-party modules
-// Space
-import { siteConfig } from "@/shared/config.ts";
-// config
-import { cn } from "@/shared/lib/cn.ts";
-// lib
-import { buttonVariants } from "@/shared/components/ui/button.tsx";
+Backend için:
+- [Prisma](https://prisma.io)
+- [Deno](https://deno.land)
+- [Ekspres](https://expressjs.com)
 
-// components
-```
+## Nasıl Katkıda Bulunabilirsin?
 
-### Class Merging
-
-The `cn` util handles conditional classes and class merging.
-
-### Input
-
-```ts
-cn("px-2 bg-slate-100 py-2 bg-slate-200");
-// Outputs `p-2 bg-slate-200`
-```
-
-## License
-
-Licensed under the
-[MIT license](https://github.com/shadcn/ui/blob/main/LICENSE.md).
+Herkesten katkı bekliyoruz. Başlamak için lütfen [katkıda bulunma kılavuzumuzu](CONTRIBUTING.md) okuyun. Yardım etmek isterseniz [issulara](https://github.com/acikkaynak/aya-website/issues) göz atabilirsiniz. Herhangi bir sorunuz varsa [Discord sunucumuza](https://discord.gg/itdepremyardim) katılmaktan çekinmeyin. Herhangi bir noktada takılırsanız, Github Issues veya Discord üzerinden yardım istemekten çekinmeyin.
diff --git a/packages/web/LICENSE b/packages/web/LICENSE
@@ -0,0 +1,20 @@
+Copyright (c) 2023 AYA Team
+
+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/packages/web/README.md b/packages/web/README.md
@@ -0,0 +1,19 @@
+# Aya - Open Source Network Web
+[![Discord](https://img.shields.io/discord/1072074800622739476?color=7289da&logo=discord&logoColor=white)](https://discord.gg/itdepremyardim)
+![GitHub issues](https://img.shields.io/github/issues/acikkaynak/aya-website)
+
+# 💻 Deploy locally
+## 📦 Requirements
+1. Make sure you have [Node.js](https://nodejs.org/en/) installed.
+2. Make sure you have [Git](https://git-scm.com/) installed.
+3. We use PNPM as package manager. Make sure you have [PNPM](https://pnpm.js.org/) installed.
+
+## 🚀 Installation
+1. Clone the repository with `git clone`.
+2. Install the dependencies with `pnpm install`.
+3. Run the project with `pnpm dev`.
+
+You can now open your browser and go to http://localhost:3000 to connect to the application.
+
+# 📝 License
+This project is licensed under the [MIT License](./LICENSE).