Skip to content

EricOgie/zc_core

 
 

Repository files navigation

ZC_CORE Go Reference

Zuri Chat Core Api

See the docs for everything:https://docs.zuri.chat/

Description

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

Language

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.

API's

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

Getting Started

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.

Prerequisites

You should have go 1.16 or lastest version already installed on your local machine.

Testing

golangci-lint run

Contributing

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.

  1. Fork/Clone the Project
  2. Create your Feature Branch (git checkout -b [branch name])
  3. Commit your Changes (git commit -m Add some amazing features)
  4. Push to the Branch (git push origin [branch name])
  5. Open a Pull Request

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Go 79.8%
  • HTML 19.4%
  • Other 0.8%