59 lines
2.6 KiB
Markdown
59 lines
2.6 KiB
Markdown
<p align="center">
|
|
<img src="https://raw.githubusercontent.com/Crossbell-Box/xLog/main/public/assets/logo.svg" alt="xLog" width="100">
|
|
</p>
|
|
<h1 align="center">xLog</h1>
|
|
|
|
> The best on-chain and open-source blogging community for everyone.
|
|
|
|
[](https://discord.gg/46VJMMVCuF) [](https://twitter.com/_xLog) [](https://github.com/Crossbell-Box/xLog/actions/workflows/docker-build-push.yml)
|
|
|
|
## Features
|
|
|
|
|
|
|
|
### Easy
|
|
|
|
Connect with your **Web3 Wallet** or **Email**. Build your own site with custom domains, subscriptions, likes, comments, minting as NFT, RSS and more in one second. No fees, no friction.
|
|
|
|
|
|
|
|
### Safe
|
|
|
|
All blog data, including configs, posts, subscriptions, comments, etc., are signed and securely stored on the blockchain with your own hands. No one else, including us, can make any changes.
|
|
|
|
|
|
|
|
### Fast
|
|
|
|
Blockchain doesn't always mean inefficiency. xLog's efficient caching mechanism and numerous optimisations take it to the peak of performance.
|
|
|
|
|
|
|
|
### Customizable
|
|
|
|
Use your own domain, customise your site and style it however you like. This is your site, there are no restrictions.
|
|
|
|
|
|
|
|
### Open
|
|
|
|
Uses **standard Markdown** with export and import tools and rich APIs for a painless move in and out. All code is **open source** on GitHub, all data is **transparent** on the chain. Domain name, navigation bar, custom styles, all as you wish, and stored on the blockchain.
|
|
|
|
|
|
|
|
## Integration
|
|
|
|
xLog's open design allows it to integrate with many other open protocols and applications without friction.
|
|
|
|
|
|
|
|
## Development
|
|
|
|
Follow the steps to run it locally.
|
|
|
|
1. Copy `.env.example` to `.env`
|
|
2. Install dependencies: `pnpm i`
|
|
3. Start dev server: `pnpm dev`
|
|
|
|
This project is developed based on [proselog](https://github.com/proselog/proselog)
|