feat(docs): update README with project overview, features, tech stack, and contribution guidelines

Author: vignesh-gupta

CODE_OF_CONDUCT.md

@@ -0,0 +1,25 @@
+# Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a friendly experience for everyone, regardless of any experience
+to give everyone an opportunity to contribute in this project.
+
+## Our Responsibilities
+
+The primary responsibility of contributors is to provide high-quality code contributions to the project. This involves writing, reviewing, and submitting code changes that improve the project's functionality, fix bugs, or implement new features.
+
+Contributors should actively participate in project discussions and communicate effectively with other contributors, maintainers, and users. Contributors should be respectful of others when commenting on issues and pull requests, as well as when interacting with other community members in any other forum.
+
+Contributors can play a role in the long-term maintenance of the project by actively monitoring the project's issue tracker, addressing bug reports and feature requests, and collaborating with other contributors to ensure the project remains healthy and sustainable.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.

CONTRIBUTION.md

@@ -0,0 +1,92 @@
+# CONTRIBUTING
+
+When contributing to this repository, please first discuss the change you wish to make via [issues](https://github.com/vignesh-gupta/clikz/issues).
+
+Please note if you are working on a certain issue then make sure to stay active with development.
+
+## Git Commit, Branch, and PR Naming Conventions
+
+When you are working with git, please be sure to follow the conventions below on your pull requests, branches, and commits:
+
+```text
+PR: #[ISSUE ID] Title of the PR
+Branch: [ISSUE ID]-title-of-the-pr (shorter)
+Commit: [[ISSUE ID]] [ACTION]: what was done
+```
+
+Examples:
+
+```text
+PR: #2 Add a new feature / layer
+Branch: 2-add-new-layer
+Commit: [2] feat: add new layer
+```
+
+## Installation
+
+To get started with **Clikz** locally, follow these steps
+
+1. Fork the repo
+
+2. Clone your fork
+
+   ```sh
+    git clone https://github.com/<YOUR_GITHUB_ACCOUNT_NAME>/clikz.git
+   ```
+
+3. Navigate to the project directory
+
+   ```sh
+   cd clikz
+   ```
+
+4. Create a .env file inside the project's root directory.
+
+5. Copy and paste variables from `.env.example` into `.env`
+
+6. Install NPM packages
+
+   ```sh
+   pnpm i
+   ```
+
+7. Start the app dev server
+
+   ```sh
+   pnpm run dev
+   ```
+
+8. Start the convex backend
+
+   ```sh
+   pnpm run convex dev
+   ```
+
+9. Open your browser and visit <http://localhost:3000> to see the application running.
+
+## Working on New Features
+
+If you're new to Github and working with open source repositories, Cody made a video a while back which walks you through the process:
+[![How to make a pull request on an open source project](https://img.youtube.com/vi/8A4TsoXJOs8/0.jpg)](https://youtu.be/8A4TsoXJOs8)
+
+If you want to work on a new feature, follow these steps.
+
+1. Fork the repo
+2. Clone your fork
+3. Checkout a new branch
+4. Do your work
+5. Commit
+6. Push your branch to your fork
+7. Go into github UI and create a PR from your fork & branch, and merge it into upstream MAIN
+
+## Pulling in changes from upstream
+
+You should pull in the changes that we add in daily, preferably before you checkout a new branch to do new work.
+
+```sh
+git checkout main
+```
+
+```sh
+git pull upstream main
+```

README.md

@@ -1,5 +1,60 @@
-- NextJs
-- Hono JS
-- Tanstack Query
-- Auth JS
-- Tinybird
+# Clikz - A Link management platform for teams
+
+![thumbnail](./apps/web/public/thumbnail.jpeg)
+
+## Intro
+
+Clikz is a powerful link management web app designed for marketers, teams, and businesses to create, organize, and analyze links effortlessly. With Clikz, you can shorten URLs, track real-time analytics, and collaborate with your team to optimize marketing campaigns. Whether you're sharing links on social media, email campaigns, or ads, Clikz gives you actionable insights to improve engagement and conversions.
+
+## Features
+
+- [x] 🔗**Smart Link Management** : Manage multiple teams, each with their own set of projects, efficiently and effectively.
+- [x] 📈**Real-Time Analytics** : Handle multiple projects simultaneously with our intuitive project management interface.
+- [x] 🤝**Team Collaboration** : Easily create and manage work items to keep track of tasks and deliverables.
+- [x] 🔐**Secure & Reliable** : Organize and manage your project resources, including links and files, all in one place
+- [x] 🎁 and many more on the way.... checkout our [roadmap](Roadmap.md)
+
+## Tech Stack
+
+### Frontend
+
+- [Next.js](https://nextjs.org/) [v14](https://nextjs.org/blog/next-14) – React framework for building performant apps with the best developer experience
+- [Auth.js](https://authjs.dev/) – A simple, secure, and scalable authentication library for JavaScript applications
+- [Tailwind](https://tailwindcss.com/) – Utility-first CSS framework for rapid UI development
+- [Shadcn UI](https://ui.shadcn.com/) - A Component library to copy and paste component built on top of Tailwind + [Radix](https://www.radix-ui.com/).
+- [React Query](https://tanstack.com/query/v3/) – Hooks for fetching, caching, and updating asynchronous data in React
+- [Lucide](https://lucide.dev/) – Beautifully simple, pixel-perfect icons
+- [Nuqs](https://nuqs.47ng.com/) – A modern, lightweight, and fast state management library in the URL for React
+
+### Backend + Database
+
+- [Hono](https://hono.dev/) – A web framework for building applications and APIs with TypeScript
+- [Prisma](https://www.prisma.io/) – Next-generation ORM for Node.js and TypeScript
+- [Neon DB](https://neon.tech//) – A fast, serverless, and scalable database for modern applications
+
+### Platform
+
+- [Vercel](https://vercel.com/) – The best platform for deploying Next.js apps with zero configuration
+
+### Code Quality
+
+- [TypeScript](https://www.typescriptlang.org/) – Static type checker for end-to-end type-safety
+- [Prettier](https://prettier.io/) – Opinionated code formatter for consistent code style
+- [ESLint](https://eslint.org/) – Pluggable linter for Next.js & TypeScript
+
+## Contributing
+
+We welcome contributions to Clikz! If you'd like to contribute, you can follow [contribution guide](CONTRIBUTION.md). Be sure to follow our [code of conduct](CODE_OF_CONDUCT.md).
+
+## License
+
+Clikz is licensed under the [MIT License](LICENSE).
+
+## Author
+
+- [![@vigneshfixes](https://img.shields.io/badge/vigneshfixes-000000?style=for-the-badge&logo=x&logoColor=white)](https://twitter.com/intent/follow?screen_name=vigneshfixes)
+- [![Vignesh Gupta](https://img.shields.io/badge/Website-000000?style=for-the-badge&logo=About.me&logoColor=white)](https://vigneshgupta.vercel.app/)
+
+## Thank you!
+
+Hope you like it. Please do ⭐ the repo. Happy coding!

Roadmap.md

@@ -0,0 +1,27 @@
+# Feature Roadmap
+
+## Upcoming Features
+
+- [ ] Adding custom domain
+- [ ] Adding blogs
+- [ ] Open endpoint for automation
+- [ ] Custom packages for different languages
+
+## Completed Features
+
+- [x] Link management
+- [x] Real-time analytics
+- [x] Team collaboration
+
+## In Progress
+
+- [ ] User Settings
+- [ ] Improved analytics
+
+## Planned
+
+- Adding custom domain
+- Improved analytics
+- Adding blogs
+- Open endpoint for automation
+- Custom packages for different languages