feat: update readme (#167)
* chore: add logos * chore: add contributing
This commit is contained in:
Nathan.fooo
GitHub
parent
147317bd1c
commit
3e9e42d59e
65
README.md
65
README.md
|
|
@ -1,10 +1,36 @@
|
||||||
# AppFlowy Cloud
|
<p align="center">
|
||||||
- Cloud Server for AppFlowy
|
<img src="assets/logos/appflowy_logo.svg" width="500" height="200" />
|
||||||
|
</p>
|
||||||
|
|
||||||
## Deployment
|
<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
|
||||||
|
|
||||||
|
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)
|
- See [deployment guide](./doc/deployment.md)
|
||||||
|
|
||||||
## Development
|
## 💻 Development
|
||||||
|
|
||||||
### Pre-requisites
|
### Pre-requisites
|
||||||
|
|
||||||
|
|
@ -55,9 +81,15 @@ After the server is running, you can run the tests with:
|
||||||
cargo test
|
cargo test
|
||||||
```
|
```
|
||||||
|
|
||||||
### Debugging
|
## 🐞Debugging
|
||||||
#### Postgres
|
|
||||||
- [PgAdmin](http://localhost:5400)
|
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:
|
- OR command line:
|
||||||
```bash
|
```bash
|
||||||
export PGPASSWORD=password
|
export PGPASSWORD=password
|
||||||
|
|
@ -65,12 +97,23 @@ cargo test
|
||||||
```
|
```
|
||||||
|
|
||||||
- Redis
|
- Redis
|
||||||
|
|
||||||
|
Redis offers a powerful command line interface for managing your Redis instance. Connect using the following command:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
redis-cli -p 6380
|
redis-cli -p 6380
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Minio
|
### Minio
|
||||||
- [Web UI](http://localhost:9001)
|
|
||||||
|
|
||||||
#### Portainer
|
Minio provides a Web UI for easy management of your files and buckets. Access it at [Web UI](http://localhost:9001)
|
||||||
- [Web UI](http://localhost:9442)
|
|
||||||
|
### 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
|
||||||
|
|
||||||
|
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!
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,40 @@
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 761.68 143.1">
|
||||||
|
<g data-name="Layer 2">
|
||||||
|
<g data-name="Layer 1">
|
||||||
|
<path
|
||||||
|
d="M271 40.73h18v6.7c4.37-4.68 12.64-8.42 21.69-8.42C330 39 342.5 54 342.5 74.74c0 21.38-14.67 37.92-37.14 37.92-6.24 0-12.32-1.09-16.38-3.44v32.93H271zm18 22.78v28.4c4.84 3.12 8.89 4 14.82 4 12.48 0 19.66-9 19.66-20.75 0-11.24-6.55-19.35-18.41-19.35-6.07.05-11.72 2.86-16.07 7.7zM226.66 39.4c-22.48 0-37.14 16.54-37.14 37.91 0 20.76 12.47 35.74 31.83 35.74 9 0 17.31-3.75 21.68-8.43v6.72h18V52.42c-13.35-10.06-28.14-13.02-34.37-13.02zM243 88.55c-4.37 4.83-10 7.64-16.07 7.64-11.85 0-18.41-8.11-18.41-19.34 0-11.7 7.18-20.76 19.66-20.76 5.93 0 10 .94 14.82 4.07zM350.16 40.73h17.95v6.7c4.36-4.68 12.63-8.42 21.68-8.42 19.35 0 31.84 15 31.84 35.73 0 21.38-14.67 37.92-37.14 37.92-6.24 0-12.33-1.09-16.38-3.44v32.93h-17.95zm17.95 22.78v28.4c4.83 3.12 8.89 4 14.82 4 12.48 0 19.66-9 19.66-20.75 0-11.24-6.55-19.35-18.41-19.35-6.09.05-11.71 2.86-16.07 7.7zM473.63 20.6a20.34 20.34 0 00-11.08-3.75c-8.11 0-12.32 4.22-12.32 13.89v10h12.64v16.84h-12.64v53.36h-18v-81.6c0-19.51 9.36-29.34 25-29.34 7.18 0 13.73 1.72 18.41 4.68h15.92v79.58c0 8 2 11.39 6.08 11.39a12.6 12.6 0 007.49-2.81l3.75 13.73c-4.06 3.28-10.15 5.93-18.57 5.93-10.77 0-16.7-6.55-16.7-20.91zM547.12 39c23.25 0 38.23 15.76 38.23 36.82s-15 36.83-38.23 36.83S508.9 96.9 508.9 75.83 523.87 39 547.12 39zm0 57c11.08 0 19.2-8 19.2-20.13 0-11.86-8.27-20-19.2-20-10.61 0-19 7.8-19 20-.03 11.67 8.08 20.13 19 20.13zM674.14 111.25h-16.07l-15-39c-1.1-2.65-1.56-5.61-2.34-8.27a50.32 50.32 0 01-2.5 8.59l-14.82 38.69h-15.3l-22.76-70.53h19.2L615.78 79a73.76 73.76 0 012 9.37 91.46 91.46 0 012.68-9.37l13.11-38.22h15.91l13.58 38.02a98.26 98.26 0 012.65 9.67c.63-3.28 1.41-6.71 2.18-10.14l10.3-37.6h18.1z"
|
||||||
|
fill="#fff" />
|
||||||
|
<path
|
||||||
|
d="M734.06 110.94c-10.3 25.12-16.85 31.21-27.15 31.21-6.4 0-11.08-2.5-15.14-5.46l5.78-13.58c1.87 1.09 4.52 2.5 7.33 2.5 4.53 0 7.8-3.59 10.77-10.92l1.56-3.75-32.46-70.21h21.54l16.38 38.38c1.4 3.43 2.34 6.71 3.43 10.14A71.08 71.08 0 01728.6 79l12.64-38.22h20.44z"
|
||||||
|
fill="#fff" />
|
||||||
|
<path
|
||||||
|
d="M140.91 87.45c-4 21.87-21.71 41-42.18 51.75-2.57 1.35-3.58 2.12-6.47 2.3h41.49a7 7 0 007.2-7V87.45z"
|
||||||
|
fill="#f7931e" />
|
||||||
|
<path d="M95.68 140.24a15.15 15.15 0 01-2.52 0z" fill="#ffce00" />
|
||||||
|
<path
|
||||||
|
d="M54.36 45.23c-.63.51-1.25 1-1.89 1.44C42 54.06 9.9 78 2.65 67.71-4.46 57.58 3 28.86 21.49 15c.35-.28.71-.53 1.06-.78 20-14.09 35-12.13 42.28-1.81 6.8 9.72-.83 24.9-10.47 32.82z"
|
||||||
|
fill="#8427e0" />
|
||||||
|
<path
|
||||||
|
d="M132.72 67.41c-9.91 7-25.55-1.17-33.32-11.14-.31-.4-.61-.81-.91-1.22-7.38-10.51-31.34-42.57-21-49.82s39.94.67 53.45 19.9c.3.43.59.85.87 1.27 13.1 19.4 11 33.91.91 41.01z"
|
||||||
|
fill="#00b5ff" />
|
||||||
|
<path
|
||||||
|
d="M119.45 130.66c-.34.26-.69.52-1 .76-20 14.09-35 12.12-42.28 1.82-6.79-9.68.8-24.85 10.46-32.78.62-.52 1.26-1 1.9-1.45C99 91.62 131.06 67.67 138.31 78c7.11 10.1-.38 38.83-18.86 52.66z"
|
||||||
|
fill="#ffbd00" />
|
||||||
|
<path
|
||||||
|
d="M63.51 140.45c-10.32 7.24-39.94-.67-53.45-19.91-.28-.38-.54-.77-.8-1.16-13.19-19.44-11.1-34-1-41.08 9.9-7 25.55 1.15 33.31 11.12.31.4.62.82.91 1.23 7.38 10.49 31.34 42.55 21.03 49.8z"
|
||||||
|
fill="#e3006d" />
|
||||||
|
<path
|
||||||
|
d="M54.36 45.23C40 51.53 9.65 64.64 5.08 54.12 1.25 45.3 8.34 27.25 21.49 15c.35-.28.71-.53 1.06-.78 20-14.09 35-12.13 42.28-1.81 6.8 9.72-.83 24.9-10.47 32.82z"
|
||||||
|
fill="#9327ff" />
|
||||||
|
<path
|
||||||
|
d="M132.72 67.41c-9.91 7-25.55-1.17-33.32-11.14C93 41.57 80.68 12.49 91 8c9.26-4 28.65 4 40.83 18.37 13.08 19.43 10.98 33.94.89 41.04z"
|
||||||
|
fill="#00c8ff" />
|
||||||
|
<path
|
||||||
|
d="M119.45 130.66c-.34.26-.69.52-1 .76-20 14.09-35 12.12-42.28 1.82-6.79-9.68.8-24.85 10.46-32.78 14.32-6.3 44.72-19.42 49.29-8.91 3.79 8.83-3.3 26.89-16.47 39.11z"
|
||||||
|
fill="#ffce00" />
|
||||||
|
<path
|
||||||
|
d="M50 137.65c-9.23 4-28.57-3.94-40.75-18.27-13.19-19.44-11.1-34-1-41.08 9.9-7 25.55 1.15 33.31 11.12C48 104.11 60.28 133.2 50 137.65z"
|
||||||
|
fill="#fb006d" />
|
||||||
|
</g>
|
||||||
|
</g>
|
||||||
|
</svg>
|
||||||
|
After Width: | Height: | Size: 4.2 KiB |
|
|
@ -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
|
||||||
|
```
|
||||||
Loading…
Reference in New Issue