bravo68web
/
shx
mirror of https://github.com/BRAVO68WEB/shx.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
shx/packages/api
History
Jyotirmoy Bandyopadhayaya 407b34bcfa
⚙ : Reworked Config Gen 		2023-06-24 23:22:22 +05:30
..
bin 🪣 : Added DB Fetch script + init DB dummp refresh 2023-05-26 13:40:38 +05:30
configs feat: use zod to read and parse config 2023-06-23 07:45:42 +00:00
controllers ⚙ : Reworked Config Gen 2023-06-24 23:22:22 +05:30
data feat: use zod to read and parse config 2023-06-23 07:45:42 +00:00
dbdump feat: Added API Key last used attribute in API 2023-06-23 06:56:30 +00:00
graphql feat: Added API Key last used attribute in API 2023-06-23 06:56:30 +00:00
hasura remove db creds (reset them to prevent exploits) 2023-05-25 13:21:38 +05:30
helpers feat: use zod to read and parse config 2023-06-23 07:45:42 +00:00
interfaces Added Metadata to URLStore API routes 2023-06-24 13:11:31 +05:30
libs feat: use zod to read and parse config 2023-06-23 07:45:42 +00:00
middlewares Create CONTRIBUTING.md ✨ 2023-05-16 19:35:51 +05:30
routes ⚙ : Reworked Config Gen 2023-06-24 23:22:22 +05:30
services ⚙ : Reworked Config Gen 2023-06-24 23:22:22 +05:30
types 👻: Remove unused vars 2023-06-11 04:32:07 +00:00
uploads Fixes #16 2023-05-29 08:18:29 +00:00
validators Added Metadata to URLStore API routes 2023-06-24 13:11:31 +05:30
.env.example Docker compose minor update 2023-05-31 09:29:15 +00:00
.gitignore Fixes #16 2023-05-29 08:18:29 +00:00
Dockerfile fix: Docker build erros 2023-06-11 19:02:02 +00:00
README.md Added Action badges to each `project's readme` 2023-05-18 08:36:06 +05:30
codegen.yml Working: Adding interfaces & tpes 2023-06-08 10:58:52 +00:00
docker-compose.yaml Docker compose minor update 2023-05-31 10:39:17 +00:00
index.ts feat: use zod to read and parse config 2023-06-23 07:45:42 +00:00
package.json feat: use zod to read and parse config 2023-06-23 07:45:42 +00:00
tsconfig.json Create CONTRIBUTING.md ✨ 2023-05-16 19:35:51 +05:30

README.md

🚀 SHX API

GitHub Workflow Status (with branch) GitHub last commit GitHub code size in bytes Snyk Vulnerabilities for GitHub Repo

forthebadge forthebadge forthebadge

📝 Description

Shx API 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. Run npm install to install dependencies.
  2. Copy the .env.example file and create a .env file with your environment variables with appropriate values.
  3. 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.