Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/recoilme/tgram
typegram: open source publishing platform
https://github.com/recoilme/tgram
gin golang medium slowpoke telegram telegraph website
Last synced: 3 months ago
JSON representation
typegram: open source publishing platform
- Host: GitHub
- URL: https://github.com/recoilme/tgram
- Owner: recoilme
- License: gpl-3.0
- Archived: true
- Created: 2018-06-22T10:09:52.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-09-30T09:09:40.000Z (about 5 years ago)
- Last Synced: 2024-09-26T15:43:26.369Z (3 months ago)
- Topics: gin, golang, medium, slowpoke, telegram, telegraph, website
- Language: Go
- Homepage: http://tgr.am
- Size: 13.3 MB
- Stars: 334
- Watchers: 27
- Forks: 32
- Open Issues: 38
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# Typegram
[typegram](https://tgr.am) - open source publishing platform.
**Basic Capabilities**
- publications, comments
- favorites, subscriptions
- mentions, tags
- ratings, votes and so on
**Playground**
You can try the service on a special [test site](https://tst.tgr.am/). Please! Use this [playground](https://tst.tgr.am/) for play with engine!
**Localization**
The service is available, for example, for [Russian-speaking](https://ru.tgr.am/), or [English-speaking](https://en.tgr.am/) users. During development, platforms for other languages are opened. On each subdomain, users and publications are separate. Please, help me to translate the welcome post for your language
[Add my country](https://github.com/recoilme/tgram/issues/43)
**Optimization**
The first thing that catches your eye is the high speed of page loads and aggressive optimization.
You will not find third-party scripts that monitor user behavior or huge styles / images. The site works with javascript turned off, it remains fast and convenient on any platform.
**Subscriptions**
On the main page, the author you are subscribed to is displayed, and the number of new publications. The link leads to the first unread message, in chronological order, as in telegram. Typegram does not impose on you whom and when to read.
**Mentions**
When someone mentions you in comments you will see it on the main page
**Editor**
The editor supports typing in markdown markup, with rich features and visual formatting. With the ability to make a post fullscreen, preview, autosave and other convenient "tidbits"
**Rating system**
You may see three sections with strange names on the main page:
**top (∧) mid (Ξ) btm (∨)**
Yes, I love DotA (my dog's name is Pudge, for example). And I'm sure that ratings are more about game mechanics/motivation than something seriously adequate. On typegram, content is divided into three parts, top, middle and bottom. All new articles go to farm the rating on the midline. Good articles go to the top. Bad articles fall to the bottom. Technically, the ranking system is copied from the ycombinator.
**Rating of the article.**
**+ 5:1 -**
Each user has 10 votes per day. You may spend them on both pluses and minuses for one article, or distribute them as you want.
The author sees both the negative and the positive reactions, separately.
**Rating of the comments**
**+ 5**
Comments are positive only. I do not know why. Do not ask. I just want to give more opportunities for collecting feedback with different mechanics. And for comments, it is possible to give only one vote per comment. You have 10 votes for comments per day. One comment is one voice.
**Tags**
Each article may have a global tag. But only one. Be smart, then choose a tag for your article.
**Monsters**
Each user has a personal monster/avatar. Approximately this:
**Notification**
If user add email in profile he will receive notifications when someone mentions him in comments
**Auto-publishing from Typegram to Telegram**
Formatting posts in telegram is not very convenient. Usually, you have to use bots and type text manually in a markdown. Write to yourself - to see what happened. And if you need to insert in the post a link to the picture - then this is inconvenient doubly.
On typegram appeared the experimental mode of autopublishing to telegram. The site has a convenient editor, with autosave, uploading pictures, editing and publishing. Now, there is the possibility of automatic publication to telegram.
All what you need:
- add @type2telegrambot as administrator in channel
- add telegram channel in profile settings
That's all. At the next publication - the typegram converts the post into a telegram markup and publishes it. Public and private channels are supported. And you can edit article directly on the site.
**Stats**
All stats are open and available at this site: [stat.tgr.am](https://stat.tgr.am)
**Android**
[Experimental app](https://github.com/vogster/Typegram-android)
**Openness**
The project is free and open source. I always welcome comments and suggestions on [github](https://github.com/recoilme/tgram)
**Weekly news digest**
[subscribe on weekly digest here](https://www.producthunt.com/upcoming/typegram)
**App**
This app uses [slowpoke](https://github.com/recoilme/slowpoke) as the database. Package slowpoke implements a low-level key/value store in pure Go. This database engine was developed specially for typegram
# How it works
```
.
├── main.go
├── routers
│ ├── routers.go //routers
└── models.go
├── article.go //data models for article
└── user.go //data models for user
```
# Getting started
You only need golang to run typegram
## Install Golang
https://golang.org/doc/install
## Environment Config
make sure your ~/.*shrc has the following variables:
```
➜ echo $GOPATH
/Users/zitwang/test/
➜ echo $GOROOT
/usr/local/go/
➜ echo $PATH
...:/usr/local/go/bin:/Users/zitwang/test//bin:/usr/local/go//bin
```
Replace _zitwang_ with your own username.
## Fresh
Fresh can help you rebuild and restart Typegram automatically
```
go get -u github.com/pilu/fresh
```
## Env
You may create a tgram.env file with startup params, sample:
```
TGRAMPWD=SOM2324&E*&Ff!!EDjweljf
TGRAMPORT=:8081
TGRAMTITLE=typegram
TGRAMNAME=Typegram
TGRAMDESC=zen platform for writers
TGRAMADMIN=recoilme
TGRAMABOUT=/@recoilme/1
TGRAMDOMAIN=tgr.am
```
## Start
```
➜ go get ./...
➜ go build
➜ ./tgram
```
## Thanks
[oh-md (markdown-editor)](https://github.com/fr4nki/oh-md)
[awsm.css](https://github.com/igoradamenko/awsm.css)
[realworld.io](https://realworld.io)
[dithering](https://github.com/MaxHalford/halfgone)
## Design
[egorabaturov](https://egorabaturov.com)
[razuvaev](http://be.net/razuvaev)
## Dev branch
- master
## Contributors
[Contributors](https://github.com/recoilme/tgram/graphs/contributors)
You are welcome to!
## Plans
I try to build the new big thing for blogging) Much more than just a text version of medium. But i started from scratch.
The mobile version will be an incredible publishing platform for both writers and readers alike. Subscribe to be the first!
https://www.producthunt.com/upcoming/typegram