feat: update readme (AppFlowy-IO#167)

* chore: add logos

* chore: add contributing

README.md

@@ -1,10 +1,36 @@
+<p align="center">
+  <img src="assets/logos/appflowy_logo.svg"  width="500" height="200" />
+</p>
+
+<h4 align="center">
+   <a href="https://discord.gg/9Q2xaN37tV"><img src="https://img.shields.io/badge/AppFlowy.IO-discord-orange"></a>
+    <a href="https://opensource.org/licenses/AGPL-3.0"><img src="https://img.shields.io/badge/license-AGPL-purple.svg" alt="License: AGPL"></a>
+</h4>
+
+
+<p align="center">
+    <a href="https://www.appflowy.io"><b>Website</b></a> •
+    <a href="https://twitter.com/appflowy"><b>Twitter</b></a>
+</p>
+
+<p align="center">⚡ The AppFlowy Cloud written with Rust 🦀</p>
+
 # AppFlowy Cloud
-- Cloud Server for AppFlowy
 
-## Deployment
+AppFlowy Cloud is the backbone of the AppFlowy ecosystem, offering secure user authentication, robust file storage, 
+and real-time WebSocket communication for an efficient and collaborative user experience.
+
+## Table of Contents
+- [🚀 Deployment](#-deployment)
+- [💻 Development](#-development)
+- [🐞 Debugging](#-debugging)
+- [⚙️ Contributing](#-contributing)
+
+
+## 🚀 Deployment
 - See [deployment guide](./doc/deployment.md)
 
-## Development
+## 💻 Development
 
 ### Pre-requisites
 
@@ -55,22 +81,39 @@ After the server is running, you can run the tests with:
 cargo test
 ```
 
-### Debugging
-#### Postgres
-- [PgAdmin](http://localhost:5400)
+## 🐞Debugging
+
+Effective debugging is essential for maintaining a healthy application. Here are some tools and commands to help you 
+troubleshoot issues in various components of the AppFlowy cloud server:
+
+### Postgres
+
+A web-based administration tool for PostgreSQL. Access it at [PgAdmin](http://localhost:5400)
+
 - OR command line:
 ```bash
     export PGPASSWORD=password
     psql --host=localhost --username=postgres --port=5433
 ```
 
 - Redis
+
+Redis offers a powerful command line interface for managing your Redis instance. Connect using the following command:
+
 ```bash
     redis-cli -p 6380
 ```
 
-#### Minio
-- [Web UI](http://localhost:9001)
+### Minio
+
+Minio provides a Web UI for easy management of your files and buckets. Access it at [Web UI](http://localhost:9001)
+
+### Portainer
+For managing Docker containers, Portainer's Web UI is an excellent tool. Access it at Web UI to easily manage Docker 
+environments, including container deployment, networking, volume management, and more. Access it at [Web UI](http://localhost:9442)
+
+
+## ⚙️ Contributing
 
-#### Portainer
-- [Web UI](http://localhost:9442)
+Any new contribution is more than welcome in this project!
+If you want to know more about the development workflow or want to contribute, please visit our [contributing guidelines](./doc/CONTRIBUTING.md) for detailed instructions!

doc/CONTRIBUTING.md

@@ -0,0 +1,68 @@
+# Contributing <!-- omit in toc -->
+
+First of all, thank you for contributing to AppFlowy Cloud! The goal of this document is to provide everything you need 
+to know in order to contribute to AppFlowy Cloud and its different integrations.
+
+- [Assumptions](#assumptions)
+- [How to Contribute](#how-to-contribute)
+- [Development Workflow](#development-workflow)
+
+
+## Assumptions
+
+1. **You're familiar with [GitHub](https://github.com) and the [Pull Request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests)(PR) workflow.**
+2. **You know about the [AppFlowy community](https://discord.gg/9Q2xaN37tV"). Please use this for help.**
+
+## How to Contribute 
+
+Contributions are welcome! Here's how you can help improve AppFlowy Cloud:
+
+1. Identify or propose enhancements or fixes by checking [existing issues](https://github.com/AppFlowy-IO/AppFlowy-Cloud/issues) or [creating a new one](https://github.com/AppFlowy-IO/AppFlowy-Cloud/issues/new/choose).
+2. [Fork the repository](https://help.github.com/en/github/getting-started-with-github/fork-a-repo) to your own GitHub account. Feel free to discuss your contribution with a maintainer beforehand.
+3. [Create a feature or bugfix branch](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-and-deleting-branches-within-your-repository) in your forked repo.
+4. Familiarize yourself with the [Development Workflow](#development-workflow) for guidelines on maintaining code quality.
+5. Implement your changes on the new branch.
+6. [Open a Pull Request (PR)](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork) against the `main` branch of the original AppFlowy Cloud repo. Await feedback or approval from the maintainers.
+
+
+## Development Workflow 
+
+To get the server running locally, execute:
+
+```bash
+./build/run_local_server.sh
+```
+
+Ensure functionality by executing the test suite:
+
+```bash
+cargo test
+```
+
+For a pull request (PR) to be considered, it must:
+
+- Pass all tests.
+- Adhere to [`clippy`](https://github.com/rust-lang/rust-clippy) linting standards:
+
+  ```bash
+  cargo clippy -- -D warnings
+  ```
+
+  If `clippy` is not installed:
+
+  ```bash
+  rustup update
+  rustup component add clippy
+  ```
+
+- Comply with the code formatting rules. To format your code:
+
+  ```bash
+  cargo fmt
+  ```
+
+  To check formatting:
+
+  ```bash
+  cargo fmt --all -- --check
+  ```