Merge pull request Multiwoven#74 from Multiwoven/docs/readme

docs: update readme for multiwoven ui

.env.example

@@ -0,0 +1 @@
+VITE_API_HOST = https://api.multiwoven.com

README.md

@@ -1,25 +1,107 @@
-# Multiwoven
+<div align="center">
+  <a href="https://multiwoven.com?utm_source=github" target="_blank">
+    <img alt="Multiwoven Logo" src="https://framerusercontent.com/images/QI2W5kDjl2HGKnAISsV9WVxcR0I.png?scale-down-to=512" width="280"/>
+  </a>
+</div>
 
-[![CI](https://github.com/Multiwoven/multiwoven-ui/actions/workflows/ci.yml/badge.svg)](https://github.com/Multiwoven/multiwoven-ui/actions/workflows/ci.yml)
-[![Maintainability](https://api.codeclimate.com/v1/badges/ac28cea2714ae9868d9e/maintainability)](https://codeclimate.com/repos/658845e86ce9037ff3f7115b/maintainability)
-[![Test Coverage](https://api.codeclimate.com/v1/badges/ac28cea2714ae9868d9e/test_coverage)](https://codeclimate.com/repos/658845e86ce9037ff3f7115b/test_coverage)
+<br/>
 
-<i>Multiwoven is an open-source **Reverse ETL** data activation platform for modern teams.</i>
+<p align="center">
+   <a href="https://github.com/Multiwoven/multiwoven"><img src="https://img.shields.io/badge/Contributions-welcome-brightgreen.svg" alt="Contributions Welcome"></a>
+   <a href="https://github.com/Multiwoven/multiwoven-server/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-AGPL-blue.svg" alt="AGPL License"></a>
+  <a href="https://github.com/Multiwoven/multiwoven-server/actions/workflows/ci.yml"><img src="https://github.com/Multiwoven/multiwoven-server/actions/workflows/ci.yml/badge.svg" alt="CI"></a>
+  <a href="https://github.com/Multiwoven/multiwoven-server/actions/workflows/docker-build.yml"><img src="https://github.com/Multiwoven/multiwoven-server/actions/workflows/docker-build.yml/badge.svg" alt="Docker Build"></a><br />
+  <a href="https://codeclimate.com/repos/657bb07835753500df74ff6a/maintainability"><img src="https://api.codeclimate.com/v1/badges/5f5a5f94f8c86a1fb02b/maintainability" alt="Maintainability"></a>
+  <a href="https://codeclimate.com/repos/657bb07835753500df74ff6a/test_coverage"><img src="https://api.codeclimate.com/v1/badges/5f5a5f94f8c86a1fb02b/test_coverage" alt="Test Coverage"></a>
+</p>
 
-The platform connects to popular data warehouses, including **Redshift, Snowflake, Databricks, and Google BigQuery**.<br /> 
-Multiwoven also facilitates the crafting of data models and enables efficient synchronization of data to various destinations. Key integrations include Facebook Ads, CRM systems such as Salesforce, email marketing tools like Braze and Klaviyo, and analytics services including Adobe Analytics, making data activation accessible for every business.
+<h2 align="center">The open-source Reverse ETL platform for data teams</h2>
 
-## Documentation
+<div align="center">Effortlessly sync customer data from the datawarehouse into your business tools.</div>
 
-The official Multiwoven documentation is available here : https://docs.multiwoven.com
+<p align="center">
+    <br />
+    <a href="https://docs.multiwoven.com" rel=""><strong>Explore the docs »</strong></a>
+    <br />
+  <br/>
+  <a href="https://join.slack.com/t/multiwoven/shared_invite/zt-2bnjye26u-~lu_FFOMLpChOYxvovep7g">Slack</a>
+    ·
+    <a href="https://github.com/Multiwoven/multiwoven-server/issues/new">Report Bug</a>
+    ·
+    <a href="https://github.com/Multiwoven/multiwoven-server/issues/new">Request Feature</a>
+    ·
+    <a href="https://github.com/orgs/Multiwoven/projects/4">Roadmap</a>
+</p>
+
+## Multiwoven UI
+
+**Multiwoven UI** repository contains the frontend codebase for the Multiwoven platform. It is built using React and Chakra UI. The frontend is responsible for managing the sources, destinations, models, and syncs.
+
+## Table of Contents
+
+- [Prerequisites](#prerequisites)
+- [Local Setup](#local-setup)
+- [Contributing](#contributing)
+- [Need Help?](#need-help)
+- [License](#license)
+
+## Prerequisites
+
+You will need the following things properly installed on your computer.
+
+- [Git](https://git-scm.com/)
+- [Node.js](https://nodejs.org/) (with npm, recommended node version - 18.17.0)
+
+## Local Setup
+
+To deploy the Multiwoven UI locally, follow the steps below:
+
+1. **Clone the repository:**
+
+```bash
+git clone [email protected]:Multiwoven/multiwoven-ui.git
+```
+
+2. **Go inside multiwoven-ui folder:**
+
+```bash
+cd multiwoven-ui
+```
+
+3. **Install the dependencies:**
+
+```bash
+npm i
+```
+
+4. **Initialize .env file:**
+
+```bash
+mv .env.example .env
+```
+
+4. **Start the services:**
+
+```bash
+npm run dev
+```
+
+5. **Access the application:**
+
+```bash
+http://localhost:8000
+```
+
+Note: In the env, the base URL for the mutiwoven server is pointing to the staging deployed URL. If you want it to point to the local server, you will have to make sure the multiwoven server is setup locally on your machine.
+Follow the steps [here](https://github.com/Multiwoven/multiwoven-server/tree/main?tab=readme-ov-file#local-setup) to set it up locally.
 
 ## Contributing
 
-The contribution documentation is available [here](https://github.com/Multiwoven/multiwoven/blob/main/CONTRIBUTING.md)
+The contribution documentation is available [here](https://github.com/Multiwoven/multiwoven-ui/blob/main/CONTRIBUTING.md)
 
-## UI Development Environment
+## Need Help?
 
-Check the wiki [guide](https://github.com/Multiwoven/multiwoven/wiki)
+We are always here to help you. If you have any questions or need help with Multiwoven, please feel free to reach out to us on [Slack](https://join.slack.com/t/multiwoven/shared_invite/zt-2bnjye26u-~lu_FFOMLpChOYxvovep7g). We are open to discuss new ideas, features, and improvements.
 
 ## License