Simsz / sharex-api

ShareX API

This is a Node.js API for ShareX with Docker support. This is ideal if you want to use ShareX with your own server and domain. The API is fully documented with OpenAPI.

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

(back to top)

Built With

(back to top)

Getting Started

Prerequisites

This can be ran with docker or node.js directly.

Installation

It is suggested to use the ShareX API installer docker image. This will generate all of the required configs and docker-compose files needed for the optimal experience.

(back to top)

Usage

I suggest starting the API with docker-compose. You can find an example here.

(back to top)

Roadmap

• 100% Coverage

  • Better test descriptions

• e2e Testing

See the open issues for a full list of proposed features (and known issues).

(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/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Ryan Bucshon - @BuSheeZy_Dev - [e-mail]

Project Link: https://github.com/BuSheeZy/sharex-api

(back to top)

Acknowledgments

• Sikari
  • Thanks to Sikari for great feedback.

(back to top)