Menu

Tree [f2d5a7] main /
 History

HTTPS access


File Date Author Commit
 .github 2023-05-25 Jyotirmoy Bandyopadhyaya [Bravo68] Jyotirmoy Bandyopadhyaya [Bravo68] [253268] 🛹: Added `shrink`,`config` CLI commands
 packages 2023-05-25 Jyotirmoy Bandyopadhyaya [Bravo68] Jyotirmoy Bandyopadhyaya [Bravo68] [d597b5] Bump Release for `@packages/cli` & `@packages/app`
 .eslintignore 2023-05-16 Jyotirmoy Bandyopadhyaya [Bravo68] Jyotirmoy Bandyopadhyaya [Bravo68] [ad57fa] Create CONTRIBUTING.md ✨
 .eslintrc 2023-05-06 Jyotirmoy Bandyopadhyaya Jyotirmoy Bandyopadhyaya [9e52e0] Initial commit
 .gitignore 2023-05-16 Jyotirmoy Bandyopadhyaya [Bravo68] Jyotirmoy Bandyopadhyaya [Bravo68] [ad57fa] Create CONTRIBUTING.md ✨
 .graphqlrc.yaml 2023-05-16 Jyotirmoy Bandyopadhyaya [Bravo68] Jyotirmoy Bandyopadhyaya [Bravo68] [ad57fa] Create CONTRIBUTING.md ✨
 .nvmrc 2023-05-16 Jyotirmoy Bandyopadhyaya [Bravo68] Jyotirmoy Bandyopadhyaya [Bravo68] [ad57fa] Create CONTRIBUTING.md ✨
 .prettierignore 2023-05-06 Jyotirmoy Bandyopadhyaya Jyotirmoy Bandyopadhyaya [9e52e0] Initial commit
 .prettierrc 2023-05-06 Jyotirmoy Bandyopadhyaya Jyotirmoy Bandyopadhyaya [9e52e0] Initial commit
 CONTRIBUTING.md 2023-05-17 Jyotirmoy Bandyopadhyaya [Bravo68] Jyotirmoy Bandyopadhyaya [Bravo68] [385426] Removed frontend for now 🎳
 LICENSE 2023-05-06 Jyotirmoy Bandyopadhyaya Jyotirmoy Bandyopadhyaya [9e52e0] Initial commit
 README.md 2023-05-18 Jyotirmoy Bandyopadhyaya Jyotirmoy Bandyopadhyaya [fc40cb] Update README.md
 package.json 2023-05-16 Jyotirmoy Bandyopadhyaya [Bravo68] Jyotirmoy Bandyopadhyaya [Bravo68] [ec8acd] 🚢 Github actions Fixes
 third-party-licenses.txt 2023-05-06 Jyotirmoy Bandyopadhyaya Jyotirmoy Bandyopadhyaya [9e52e0] Initial commit

Read Me

🚀 Project SHX

GitHub Workflow Status
GitHub last commit
GitHub code size in bytes
Snyk Vulnerabilities for GitHub Repo

forthebadge
forthebadge
forthebadge

📝 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

🚀 Features

  • File upload
  • Image upload
  • Text upload
  • URL shortener
  • CLI Support

🎁 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.

📝 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.