Hostea
/
gitpad
mirror of https://github.com/realaravinth/gitpad
4
0
Fork 0
Code Issues 3 Projects Releases Wiki Activity
gitpad/README.md

40 lines
1.4 KiB
Markdown
Raw Permalink Normal View History

add readme
2022-02-11 12:11:54 +00:00
<div align="center">
chore: rename gists to gitpad
2022-02-20 13:51:28 +00:00
<h1> GitPad </h1>
add readme
2022-02-11 12:11:54 +00:00
<p>
feat: add gists_gists, gists_comments and gists_comments & related methods The following changes are implemented for both db-sqlx-postgres and db-sqlx-sqlite: TABLE gists_gists Stores gist metadata with unique index on gists_gists.public_id for fast lookups TABLE gists_comments Stores comment metadata TABLE gists_privacy Stores gist privacy: sqlx currently doesn't have support Postgres enums(ref: https://github.com/launchbadge/sqlx/issues/1171), so storing possible privacy values as references from this table. This table shouldn't be mutated during runtime. Possible values are already recorded in database during migrations. All runtime operations on this table must only take references. Each implementation of GistDatabase also includes a method called privacy_exists, which is called during tests to ensure that migrations are successful. VIEW gists_gists_view Gist lookups combines data from gists_users, gists_gists and gists_privacy. This SQL view boots performance(I think?). At any rate, it is much nicer to work with. QUIRKS Database indexes are i64 in SQLite while i32 in Postgres
2022-02-14 14:29:32 +00:00
**Self-Hosted GitHub Gists**
add readme
2022-02-11 12:11:54 +00:00
</p>
feat: readme: add docker img badge
2022-02-27 14:47:24 +00:00
[![Docker](https://img.shields.io/docker/pulls/realaravinth/gitpad)](https://hub.docker.com/r/realaravinth/gitpad)
chore: rename gists to gitpad
2022-02-20 13:51:28 +00:00
[![Build](https://github.com/realaravinth/gitpad/actions/workflows/linux.yml/badge.svg)](https://github.com/realaravinth/gitpad/actions/workflows/linux.yml)
[![dependency status](https://deps.rs/repo/github/realaravinth/gitpad/status.svg)](https://deps.rs/repo/github/realaravinth/gitpad)
[![codecov](https://codecov.io/gh/realaravinth/gitpad/branch/master/graph/badge.svg)](https://codecov.io/gh/realaravinth/gitpad)
feat: create and add matrix room
2022-06-13 16:42:45 +00:00
[![Chat](https://img.shields.io/badge/matrix-+gitpad:matrix.batsense.net-purple?style=flat-square)](https://matrix.to/#/#gitpad:matrix.batsense.net)
add readme
2022-02-11 12:11:54 +00:00
</div>
## Features
feat: check code upload and syntax highlighting
2022-03-12 18:16:35 +00:00
- [x] Upload code snippets
- [x] Syntax Highlighting
feat: render markdown comments
2022-04-06 06:01:39 +00:00
- [x] Comments
feat: update todo list
2022-02-18 18:29:37 +00:00
- [x] Versioning through Git
add readme
2022-02-11 12:11:54 +00:00
- [ ] Fork gists
feat: update todo list
2022-02-18 18:29:37 +00:00
- [x] Gist privacy: public, unlisted, private
feat: add git SSH and HTTP clone feature target in README
2022-02-12 18:18:21 +00:00
- [ ] Git clone via HTTP and SSH
add readme
2022-02-11 12:11:54 +00:00
- [ ] Activity Pub implementation for publishing native gists and commenting
feat: add gitea oauth integration to feat list
2022-02-18 07:15:43 +00:00
- [ ] Gitea OAuth integration
add readme
2022-02-11 12:11:54 +00:00
## Why?
Gists are nice, while there are wonderful forges like
[Gitea](https://gitea.io), there isn't a libre pastebin implementation that
can rival GitHub Gists.
## Usage
1. All configuration is done through
[./config/default.toml](./config/default.toml)(can be moved to
chore: rename gists to gitpad
2022-02-20 13:51:28 +00:00
`/etc/gitpad/config.toml`).