https://github.com/ngocphuongnb/tetua
Tetua is a simple Golang-based blogging platform. Quickly create a blog with a few simple commands.
https://github.com/ngocphuongnb/tetua
blogging cms golang
Last synced: 6 months ago
JSON representation
Tetua is a simple Golang-based blogging platform. Quickly create a blog with a few simple commands.
- Host: GitHub
- URL: https://github.com/ngocphuongnb/tetua
- Owner: ngocphuongnb
- License: mit
- Created: 2022-05-12T02:55:51.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2022-06-21T02:03:23.000Z (about 4 years ago)
- Last Synced: 2024-06-19T00:33:38.402Z (about 2 years ago)
- Topics: blogging, cms, golang
- Language: Go
- Homepage: https://tetua.net
- Size: 672 KB
- Stars: 75
- Watchers: 1
- Forks: 10
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Tetua - A simple CMS for blogging
Tetua is a simple CMS for blogging written in Golang. With tetua, you can quickly create a blog with a few simple commands.
Tetua is built on top of awesome libraries like:
- [Fiber](https://github.com/gofiber/fiber)
- [Ent](https://github.com/ent/ent)
- [Rclone](https://github.com/rclone/rclone)
- [Jade](https://github.com/Joker/jade)
## Installation
### Download the binary from the release page:
- https://github.com/ngocphuongnb/tetua/releases
### Create the config file
```sh
./tetua init
```
The config file will be created in the current directory.
```json
{
"app_env": "production",
"app_key": "{APP_KEY}",
"app_port": "3000",
"db_dsn": "",
"db_query_logging": false
}
```
*Look at the `config.example.json` for more configuration options.*
These fields are required:
- `app_key`: the key to encrypt the data
- `db_dsn`: the database connection string
You can skip this initialization step by specifying the environment variables:
- `APP_KEY`
- `DB_DSN`
### Create the Admin account
```sh
./tetua setup -u admin -p password
```
### Run the server
```sh
./tetua run
```
## Features
* Posts Management
* Page Management
* Topics Management
* Users Management
* Role and Permission Management
* Site Settings Management
* Comment Management
* File Management
* User profile page
* User posts page
* Local file upload
* S3 file upload
* Sign in with Github
* Sign in with Google
* Sign in with Twiter
## Documentation
- Documentation is hosted live at [https://tetua.net](https://tetua.net)
## Development
*Requirements:*
- Go 1.18+
- [Goreleaser](https://github.com/goreleaser/goreleaser)
The development requires Go 1.18+ as we use `generic`
### Clone the source code
```sh
git clone https://github.com/ngocphuongnb/tetua.git
cd tetua
go mod tidy
```
### Build the static editor
```sh
make build_editor
```
### Run the test
```sh
make test_all
```
### Build the local release for testing
```sh
make releaselocal
```
### Public a release
```sh
git tag -a vx.y.z -m "Release note"
git push origin vx.y.z
make release
```
## Road Map
* [ ] Pages cache
* [x] Sign in with Google
* [x] Sign in with Twitter
* [x] Sign up with email (local account)
* [ ] Serial posts
* [ ] Report Abuse
* [ ] Complete the Unit Test
## Screenshots
## Contribute
If you want to say thanks and/or support the active development of Tetua, please consider some of the following:
1. Add a GitHub Star to the project.
2. Create a pull request.
3. Fire an issue.
## License
Copyright (c) 2022-present @ngocphuongnb and Contributors. Tetua is free and open-source software licensed under the MIT License.
**Third-party libraries:**
- entgo.io/ent v0.10.1
- github.com/Joker/hpp v1.0.0
- github.com/Joker/jade v1.1.3
- github.com/go-sql-driver/mysql v1.6.0
- github.com/gofiber/fiber/v2 v2.30.0
- github.com/golang-jwt/jwt/v4 v4.4.0
- github.com/google/uuid v1.3.0
- github.com/microcosm-cc/bluemonday v1.0.18
- github.com/valyala/fasthttp v1.34.0
- go.uber.org/zap v1.21.0
- github.com/davecgh/go-spew v1.1.1
- github.com/rclone/rclone v1.58.0
- github.com/urfave/cli/v2 v2.4.0
- ariga.io/sqlcomment v0.0.0-20211020114721-6bb67a62a61a
- github.com/PuerkitoBio/goquery v1.8.0
- github.com/dghubble/oauth1 v0.7.1
- github.com/gofiber/utils v0.1.2
- github.com/gorilla/feeds v1.1.1
- github.com/tdewolff/minify/v2 v2.11.1
- github.com/gosimple/slug v1.12.0
- github.com/stretchr/testify v1.7.1
- github.com/yuin/goldmark v1.4.11