bravo68web
/
shx
mirror of https://github.com/BRAVO68WEB/shx.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
shx/packages/api/README.md

1.9 KiB
Raw Blame History

🚀 SHX API

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

forthebadge forthebadge forthebadge

📝 Description

Shx is a custom ShareX server that allows you to upload 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 AWS S3 and Redis.

🛠️ Technologies Used

  • Node.js
  • Express.js
  • TypeScript
  • Redis
  • Cloudflare R2
  • Hasura Graphql (with PostgreSQL)

🚀 Features

  • File upload
  • Image upload
  • Text upload
  • URL shortener

🚀 Getting Started

To get started with the project, follow these steps:

  1. Clone the repo.
  2. Run npm install to install dependencies.
  3. Copy the .env.example file and create a .env file with your environment variables.
  4. Run npm run dev to start the development server.

📜 Scripts

  • npm run dev: Starts the development server.
  • npm run build: Builds the project.
  • npm start: Starts the project.
  • npm run prettier: Runs Prettier to format code.

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