Warning: This is by no means a professional or company-ready project, it’s purely a hobby project. The code quality is quite rough in many places, so please be gentle! Pull requests are very welcome 😉.
Snipdox is a clean, modern code sharing platform built with Nuxt (Vue) and PostgreSQL. It allows users to share code snippets easily and optionally include error titles and details alongside the shared code.
- User authentication and session management
- Create, read and delete code snippets. (Maybe updating code snippets in the future)
- Support for private and public pastes (Work in Progress)
- Code snippet expiration management
- Syntax highlighting for various programming languages
- Basic search and pagination
- Clean and modern UI design using Vue and Nuxt
- Frontend: Nuxt 3 / Vue 3
- Backend: Node.js server endpoints (via Nuxt server engine)
- Database: PostgreSQL
- Authentication: GitHub OAuth
This project is a hobby and learning playground. If you find bugs or want to improve the code, please submit pull requests, contributions are very welcome 😉. Just keep in mind the codebase is a bit messy and not production hardened.
- Clone the stuff, use
npm installorpnpm installor what you prefer. - Rename
.env.exampleto.envand fill in the required environment variables. - Change everything from the
/public/legal/directory to your own legal documents, or remove them if you don't need them.- The files in this directory are placeholders and should not be used as-is.
- Create the database tables, all commands are listed in the
database.sqlfile in the root directory.
If you deploy this project yourself or use it for your own purposes, you MUST remove or replace all data in
the /public/legal/ directory (Imprint, Privacy Policy, etc.) before making the site public.
The provided legal files contain placeholder information only and are not intended for use by third parties. Proper
legal compliance and liability are your responsibility.
- FontAwesome for icons
- CodeMirror for code syntax highlighting
- Google Fonts for typography
This project is licensed under the MIT License. See the LICENSE file for details.