Contributors Forks Stargazers Issues MIT License

Logo

coso

An open-source HTTP back-end with realtime subscriptions using Google Cloud Storage as a key-value store. Explore the docs »

Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Building and running coso
  3. Usage
  4. Contributing
  5. License
  6. Contact

About The Project

coso is an experimental open-source HTTP back-end using Google Cloud Storage as a key-value store. It is designed to be a simple and fast way to use Google Cloud Storage as a key-value store with a HTTP interface. Real-time subscriptions are also possible via Server Sent Events.

(back to top)

Building and running coso

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

git clone https://github.com/hood/coso
cd coso
go build
./coso

coso will look for an .env file in its own folder, and will use the following environment variables:

  • BUCKET_NAME – the name of the Google Cloud Storage bucket to use (will throw if not set)
  • PORT_NUMBER – the port to listen on (default: 1337)

(back to top)

Usage

Once spun, the webserver can be hit at the following HTTP endpoints:

  • /get
    • Content-Type: application/json
    • Body: {"key": "some-key"}
  • /set
    • Content-Type: application/json
    • Body: {"key": "some-key", "value": "some-value"}
  • /list
    • Content-Type: application/json
    • Body: {"prefix": "some-prefix", "flat": true} (flat is optional, and defaults to false)

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag “enhancement”. Don’t forget to give the project a star! Thanks again!

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

(back to top)

License

Distributed under the GPL v3.0 License. See LICENSE.txt for more information.

(back to top)

Contact

Author – @0xCAP

Project Link: https://github.com/hood/coso

(back to top)

GitHub

View Github