Merge pull request #4 from gitsrc/main

IceFireDB - IceFireDB Team

Author: fenbox

IceFireDB-IceFireDB/3.1.png

@@ -0,0 +1,32 @@
+# ---> Go
+# Compiled Object files, Static and Dynamic libs (Shared Objects)
+.idea
+.DS_Store
+.vscode
+bin
+build
+*.o
+*.a
+*.so
+
+# Folders
+_obj
+_test
+
+# Architecture specific extensions/prefixes
+*.[568vq]
+[568vq].out
+
+*.cgo1.go
+*.cgo2.c
+_cgo_defun.c
+_cgo_gotypes.go
+_cgo_export.*
+
+_testmain.go
+
+*.exe
+*.test
+*.prof
+
+vendor

IceFireDB-IceFireDB/3.2.png

@@ -0,0 +1,112 @@
+# Contributing to [PROJECT'S NAME]
+
+## Create an issue
+
+- If you've encountered a bug, open a [Bug Report](https://github.com/PoCInnovation/$REPOSITORY/issues/new?assignees=&labels=&template=bug_report.md&title=).
+- If you want [PROJECT'S NAME] to have a new fonctionality, open a [Feature Request](https://github.com/PoCInnovation/$REPOSITORY/issues/new?assignees=&labels=&template=feature_request.md&title=).
+
+## Resolve an issue
+
+Select an [issue](https://github.com/PoCInnovation/$REPOSITORY/issues) that you want to resolve.
+
+The recommended workflow is to fork this repository and open pull requests from your fork.
+
+### 1. Fork, clone & configure [PROJECT'S NAME] upstream
+
+- Click on the _Fork_ button on GitHub
+- Clone the original repository
+- Add your repository as a new remote
+
+```sh
+# Clone original repository
+git clone git@github.com:PoCInnovation/$REPOSITORY.git
+
+# Add your fork as a remove
+git remote add <fork_name> https://github.com/$YOUR_GITHUB_USER/$REPOSITORY.git
+```
+
+### 2. Create a pull request
+
+```sh
+# Create a new branch
+git checkout -b my_branch
+
+# Make changes to your branch
+# ...
+
+# Commit changes - remember to sign!
+git commit -s
+
+# Push your new branch
+git push <fork name>
+
+# Create a new pull request from https://github.com/PoCInnovation/$REPOSITORY/pulls
+```
+
+### 3. Update your pull request with latest changes
+
+```sh
+# Checkout main branch
+git checkout main
+
+# Pull origin's change
+git pull
+
+# Checkout your branch
+git checkout my_branch
+
+# Rebase your branch changes on top of the updated main branch
+git rebase main
+
+# Update your pull request with latest changes
+git push -f <fork name>
+```
+
+## Commits
+
+### DCO
+
+Contributions to this project must be accompanied by a Developer Certificate of
+Origin (DCO).
+
+All commit messages must contain the Signed-off-by line with an email address that matches the commit author. When commiting, use the `--signoff` flag:
+
+```sh
+git commit -s
+```
+
+The Signed-off-by line must match the **author's real name**, otherwise the PR will be rejected.
+
+### Commit messages
+
+Please read first this article : [How to Write a Git Commit Message](https://chris.beams.io/posts/git-commit/).
+
+Then, follow these guidelines:
+
+- **Group Commits:** Each commit should represent a meaningful change. Instead, these commits should be squashed together into a single "Add Feature" commit.
+> For instance, a PR should not look like :
+> - 1) Add Feature X
+> - 2) Fix Typo
+> - 3) Changes to features X
+> - 5) Bugfix for feature X
+> - 6) Fix Linter 7)
+> - ...
+
+- Each commit should **work on its own**: it must compile, pass the linter and so on.
+> This makes life much easier when using `git log`, `git blame`, `git bisect`, etc...\
+> For instance, when doing a `git blame` on a file to figure out why a change was introduced, it's pretty meaningless to see a _Fix linter_ commit message. "Add Feature X" is much more meaningful.
+
+- Use `git rebase -i main` to group commits together and rewrite their commit message
+
+- To add changes to the previous commit, use `git commit --amend -s`. This will change the last commit (amend) instead of creating a new commit.
+
+- Format: Use the imperative mood in the subject line: "If applied, this commit
+ will _your subject line here_"
+
+- Add the following prefixes to your commit message to help trigger [automated processes](https://www.conventionalcommits.org):
+ - `docs:` for documentation changes only (e.g., `docs: Fix typo in X`);
+ - `test:` for changes to tests only (e.g., `test: Check if X does Y`);
+ - `chore:` general things that should be excluded (e.g., `chore: Clean up X`);
+ - `ci:` for internal CI specific changes (e.g., `ci: Enable X for tests`);
+
+> Made with :heart: by PoC

IceFireDB-IceFireDB/3.3.png

@@ -0,0 +1,9 @@
+FROM alpine
+
+WORKDIR /root
+
+COPY bin/redisproxy /root/redisproxy
+COPY config/config.yaml /root/config/config.yaml
+
+
+CMD /root/redisproxy -c /root/config/config.yaml

IceFireDB-IceFireDB/IceFireDB-Decentralization-Pubsub/.gitignore

@@ -0,0 +1,34 @@
+PROG=bin/Icefiredb-proxy
+
+
+SRCS=./cmd/proxy
+
+
+# git commit hash
+COMMIT_HASH=$(shell git rev-parse --short HEAD || echo "GitNotFound")
+
+# Compile the date
+BUILD_DATE=$(shell date '+%Y-%m-%d %H:%M:%S')
+# compile
+CFLAGS = -ldflags "-s -w -X \"main.BuildVersion=${COMMIT_HASH}\""
+
+GOPROXY=https://goproxy.cn,direct
+
+all:
+if [ ! -d "./bin/" ]; then \
+mkdir bin; \
+fi
+GOPROXY=$(GOPROXY) GOOS=linux GOARCH=amd64 go build $(CFLAGS) -o $(PROG) $(SRCS)
+
+# Compiling the RACE version
+race:
+if [ ! -d "./bin/" ]; then \
+	mkdir bin; \
+	fi
+GOPROXY=$(GOPROXY) go build $(CFLAGS) -race -o $(PROG) $(SRCS)
+
+clean:
+rm -rf ./bin
+
+run:
+GOPROXY=$(GOPROXY) go run --race cmd/proxy/main.go -c config/config.yaml

IceFireDB-IceFireDB/IceFireDB-Decentralization-Pubsub/CONTRIBUTING.md

@@ -0,0 +1,72 @@
+# [IceFireDB-Decentralization-Pubsub]
+
+IceFireDB Decentralization Pubsub是一个高性能、高可用性和去中心化订阅系统。
+
+它可以无缝地将使用redis发布和订阅的web2应用程序迁移到去中心化p2p订阅网络中
+
+## How does it work?
+
+### 场景介绍
+<img width="1070" alt="image" src="https://user-images.githubusercontent.com/52234994/173174080-95775add-c287-4f43-943b-686b903e67b7.png">
+
+### 系统架构
+<img width="1061" alt="image" src="https://user-images.githubusercontent.com/52234994/173174090-7c2f084b-4ccc-4c56-983b-210486f13a60.png">
+
+该应用程序适用于同一网络或不同网络上的多个节点。专用网络上NAT后面的节点可以相互通信。使用Kademlia DHT和IPFs网络发现对等发现和路由。通过支持redis pub-sub协议，构建了一个全局分布式Web3发布-订阅系统。
+
+您可以像使用redis发布订阅功能一样使用它。
+
+## Getting Started
+
+### Configuration
+
+在config目录中，用户存放项目配置文件，文件名：config.yaml，可根据自身需要进行修改
+
+```yaml
+# 项目代理配置
+proxy:
+ local_port: 16379
+ enable_mtls: false
+
+# p2p 配置
+p2p:
+ enable: true
+
+...
+```
+
+### Quickstart
+
+https://user-images.githubusercontent.com/52234994/173171008-8c73ce17-4ba7-42ec-8257-025e98d2e647.mp4
+
+直接运行二进制文件，如果需要在后台运行可以添加到systemd系统管理中
+```shell
+$ make
+$ ./bin/Icefiredb-proxy -c ./config/config.yaml
+```
+
+### Usage
+IceFireDB 订阅系统主要用法为两个命令：SUBSCRIBE 和 PUBLISH，主要实现在[pubsub](./pkg/router/redisNode/ppubsub.go)
+
+可以根据需求，进行二次开发，或者增加其他指令。
+
+SUBSCRIBE
+```shell
+$ redis-cli
+127.0.0.1:16379> SUBSCRIBE name
+...
+...
+```
+PUBLISH
+```shell
+$ redis-cli
+127.0.0.1:16379> PUBLISH name hello
+...
+...
+```
+
+## License
+Icefiredb代理使用Apache 2.0许可证。请参见 [LICENSE](./LICENSE) directory for details.
+
+## 免责声明
+当您使用本软件时，您已同意并声明本软件的作者、维护者和贡献者不对您遇到的任何风险、成本或问题负责。如果发现软件缺陷或BUG，请提交补丁以帮助改进！