mirror of https://github.com/BRAVO68WEB/shx.git
removed unused readme file
This commit is contained in:
parent
628c0094ba
commit
3438b6bbcc
|
@ -1,194 +0,0 @@
|
|||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>Welcome file</title>
|
||||
<link rel="stylesheet" href="https://stackedit.io/style.css" />
|
||||
</head>
|
||||
|
||||
<body class="stackedit">
|
||||
<div class="stackedit__html">
|
||||
<h1 id="🚀-project-shx">🚀 <strong>Project SHX</strong></h1>
|
||||
<p><img src="https://safe.b68dev.xyz/SHOJJQKU.png" alt="SHX Banner" /></p>
|
||||
<p>
|
||||
<img
|
||||
src="https://img.shields.io/github/package-json/v/BRAVO68WEB/shx?logo=npm&style=for-the-badge"
|
||||
alt="GitHub package.json version"
|
||||
/>
|
||||
</p>
|
||||
<p>
|
||||
<img
|
||||
src="https://img.shields.io/github/actions/workflow/status/bravo68web/shx/build-image.yaml?style=for-the-badge"
|
||||
alt="GitHub Workflow Status"
|
||||
/>
|
||||
</p>
|
||||
<p>
|
||||
<img
|
||||
src="https://img.shields.io/github/last-commit/bravo68web/shx?style=for-the-badge"
|
||||
alt="GitHub last commit"
|
||||
/>
|
||||
</p>
|
||||
<p>
|
||||
<img
|
||||
src="https://img.shields.io/github/languages/code-size/bravo68web/shx?style=for-the-badge"
|
||||
alt="GitHub code size in bytes"
|
||||
/>
|
||||
</p>
|
||||
<p>
|
||||
<img
|
||||
src="https://img.shields.io/snyk/vulnerabilities/github/bravo68web/shx?style=for-the-badge"
|
||||
alt="Snyk Vulnerabilities for GitHub Repo"
|
||||
/>
|
||||
</p>
|
||||
<p>
|
||||
<img
|
||||
src="https://img.shields.io/codefactor/grade/github/BRAVO68WEB/shx?logo=codefactor&style=for-the-badge"
|
||||
alt="CodeFactor Grade"
|
||||
/>
|
||||
</p>
|
||||
<p>
|
||||
<img
|
||||
src="https://img.shields.io/github/languages/top/bravo68web/shx?style=for-the-badge"
|
||||
alt="GitHub top language"
|
||||
/>
|
||||
</p>
|
||||
<p>
|
||||
<a href="https://forthebadge.com"
|
||||
><img
|
||||
src="https://forthebadge.com/images/badges/made-with-typescript.svg"
|
||||
alt="forthebadge"
|
||||
/></a>
|
||||
</p>
|
||||
<p>
|
||||
<a href="https://forthebadge.com"
|
||||
><img
|
||||
src="https://forthebadge.com/images/badges/powered-by-black-magic.svg"
|
||||
alt="forthebadge"
|
||||
/></a>
|
||||
</p>
|
||||
<p>
|
||||
<a href="https://forthebadge.com"
|
||||
><img
|
||||
src="https://forthebadge.com/images/badges/built-with-love.svg"
|
||||
alt="forthebadge"
|
||||
/></a>
|
||||
</p>
|
||||
<p>
|
||||
<a href="https://sonarcloud.io/summary/new_code?id=BRAVO68WEB_shx"
|
||||
><img
|
||||
src="https://sonarcloud.io/api/project_badges/quality_gate?project=BRAVO68WEB_shx"
|
||||
alt="Quality gate"
|
||||
/></a>
|
||||
</p>
|
||||
<h2 id="📝-description">📝 Description</h2>
|
||||
<p>
|
||||
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.
|
||||
</p>
|
||||
<h2 id="🛠️-technologies-used">🛠️ Technologies Used</h2>
|
||||
<ul>
|
||||
<li>
|
||||
<p>Node.js</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Express.js</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>TypeScript</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Redis</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Cloudflare R2</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Hasura Graphql (with PostgreSQL)</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Commander.js</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Next.js</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Tailwind CSS</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Storybook</p>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id="🚀-features">🚀 Features</h2>
|
||||
<ul>
|
||||
<li>
|
||||
<p>File upload</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Image upload</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Text upload</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>URL shortener</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>CLI Support</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Web Dashboard</p>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id="🎁-project-setup">🎁 Project Setup</h2>
|
||||
<h3 id="packagesapi">@packages/api</h3>
|
||||
<p>
|
||||
<img
|
||||
src="https://img.shields.io/github/package-json/v/BRAVO68WEB/shx?filename=packages%2Fapi%2Fpackage.json&logo=npm&style=for-the-badge"
|
||||
alt="GitHub package.json version (subfolder of monorepo)"
|
||||
/>
|
||||
</p>
|
||||
<p>
|
||||
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.
|
||||
</p>
|
||||
<h3 id="packagescli">@packages/cli</h3>
|
||||
<p>
|
||||
<img
|
||||
src="https://img.shields.io/github/package-json/v/BRAVO68WEB/shx?filename=packages%2Fcli%2Fpackage.json&logo=npm&style=for-the-badge"
|
||||
alt="GitHub package.json version (subfolder of monorepo)"
|
||||
/>
|
||||
</p>
|
||||
<p>
|
||||
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.
|
||||
</p>
|
||||
<h3 id="packagesdashboard">@packages/dashboard</h3>
|
||||
<p>
|
||||
<img
|
||||
src="https://img.shields.io/github/package-json/v/BRAVO68WEB/shx?filename=packages%2Fdashboard%2Fpackage.json&logo=npm&style=for-the-badge"
|
||||
alt="GitHub package.json version (subfolder of monorepo)"
|
||||
/>
|
||||
</p>
|
||||
<p>
|
||||
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.
|
||||
</p>
|
||||
<h2 id="📝-license">📝 License</h2>
|
||||
<p>This project is licensed under the ISC License.</p>
|
||||
<p>For more information, please see the <code>LICENSE</code> file.</p>
|
||||
<h2 id="📧-contact">📧 Contact</h2>
|
||||
<p>
|
||||
If you have any questions or would like to contribute to the project,
|
||||
please
|
||||
</p>
|
||||
<p>contact <code>hi@b68.dev</code>.</p>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
Loading…
Reference in New Issue