See the docs for everything:https://docs.zuri.chat/
The zc_core is an open source API that serves as the backend and backbone of Zuri chat.
Zuri Chat is an open source slack clone developed during the HNG8 internship program
Zuri Chat implements a plug-in system that allows for much more functionality because different plugins can be developed by different creators. These plugins can then rest on the Zuri Chat Core backbone (zc_core) which is written in Golang
Zc_core was written in Go because it is a fast, compiled language and it is easily scaled. Concurrency in Go is also ideal for implementing a plugin structure. This makes it easy to build on the project and allows for future expansion.
A list of the endpoints and the functions they implement can be found in the API folder that contains YAML files for each of the functionalities
This is an example of how you can setup your project locally. To get a local copy up and running follow these simple example steps.
You should have go 1.16 or lastest version already installed on your local machine.
golangci-lint run
Pull requests are welcome from the zc_core_main team. Please review the issues created before making a pull request or create an issue if the issue you solve is not already listed.
- Fork/Clone the Project
- Create your Feature Branch (
git checkout -b [branch name]
) - Commit your Changes (
git commit -m Add some amazing features
) - Push to the Branch (
git push origin [branch name]
) - Open a Pull Request