mirror of https://github.com/BRAVO68WEB/shx.git
Jyotirmoy Bandyopadhayaya
dc9d239c8c
|
||
|---|---|---|
| .github/workflows | ||
| bin | ||
| configs | ||
| controllers | ||
| data | ||
| graphql | ||
| hasura | ||
| helpers | ||
| interfaces | ||
| libs | ||
| middlewares | ||
| routes | ||
| services | ||
| types | ||
| .env.example | ||
| .eslintignore | ||
| .eslintrc | ||
| .gitignore | ||
| .graphqlrc.yaml | ||
| .prettierignore | ||
| .prettierrc | ||
| Dockerfile | ||
| LICENSE | ||
| README.md | ||
| index.ts | ||
| package.json | ||
| third-party-licenses.txt | ||
| tsconfig.json | ||
README.md
🚀 SHX SERVER
📝 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:
- Clone the repo.
- Run
npm installto install dependencies. - Copy the
.env.examplefile and create a.envfile with your environment variables. - Run
npm run devto 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.