3.4 KiB
🚀 Project SHX
📝 Description
Shx is a platform ment to store and share files, images, text and URLs with ease. This server is built using Node.js and Express.js and stores the uploaded content on Cloudflare R2 and PostgreSQL DB. It is compatible with ShareX and other clients that support the same protocol.
🛠️ Technologies Used
- Node.js
- Express.js
- TypeScript
- Redis
- Cloudflare R2
- Hasura Graphql (with PostgreSQL)
- Commander.js
- Next.js
- Tailwind CSS
- Storybook
🚀 Features
- File upload
- Image upload
- Text upload
- URL shortener
- CLI Support
- Web Dashboard
🎁 Project Setup
@packages/api
The API package contains the server-side code responsible for handling file, image, and text uploads, as well as URL shortening. It provides the core functionality of the ShareX server.
@packages/cli
The CLI package includes the command-line interface (CLI) for interacting with the ShareX server from the terminal. It allows users to perform various actions, such as uploading files, images, or text, and generating short URLs.
@packages/dashboard
The dashboard package contains the web dashboard for the ShareX server. It allows users to view their uploaded files, images, and text, as well as manage their account and settings via a web interface.
📝 License
This project is licensed under the ISC License.
For more information, please see the LICENSE file.
📧 Contact
If you have any questions or would like to contribute to the project, please
contact hi@b68.dev.