From 79e2835c32b3c111fe45d7cd5caa070a2961ba72 Mon Sep 17 00:00:00 2001 From: DIYgod Date: Sat, 15 Apr 2023 00:09:28 +0100 Subject: [PATCH] docs: update README and add CONTRIBUTING.md --- CONTRIBUTING.md | 33 ++++++++++++++++++++++++++++ README.md | 57 ++++++++++++------------------------------------- 2 files changed, 47 insertions(+), 43 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..afc4d597 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,33 @@ +# Contributing + +So you want to help? That's great! + +Here are a few things to know to get you started on the right path. + +Below link will help you making a copy of the repository in your local system. + +https://docs.github.com/en/get-started/quickstart/fork-a-repo + +## Requirements + +- [Node.js](https://nodejs.org). Version needs to be >=15. +- [pnpm](https://pnpm.io/) package manager. +- [Docker](https://www.docker.com/) for running the cache database. + +## Development Installation + +Follow the steps below to run it locally for the first time. + +1. Copy `.env.example` to `.env` +2. Install dependencies: `pnpm i` +3. Run the databases via docker-compose: `pnpm docker:db` +4. Initialize the databases: `pnpm prisma:migrate:dev` +5. Start dev server: `pnpm dev` + +The database is only needed for the first run, afterwards you just need to start the server `pnpm dev` + +## Last words + +Don't get daunted if it is hard in the beginning. We have a great community with only encouraging words. So if you get stuck, ask for help and hints in the Discord server. If you want to show off something good, show it off there. + +[Join our Discord server if you want closer contact!](https://discord.gg/46VJMMVCuF) diff --git a/README.md b/README.md index cc0389cf..74f769cf 100644 --- a/README.md +++ b/README.md @@ -3,56 +3,27 @@

xLog

-> The best on-chain and open-source blogging community for everyone. +> 🪽 The best on-chain and open-source blogging community for everyone. [![Discord](https://img.shields.io/badge/chat-Discord-5865F2.svg?logo=discord&style=flat-square)](https://discord.gg/46VJMMVCuF) [![Twitter](https://img.shields.io/badge/Twitter-@_xLog-1d9bf0.svg?logo=twitter&style=flat-square)](https://twitter.com/_xLog) [![build](https://img.shields.io/github/actions/workflow/status/Crossbell-Box/xLog/docker-build-push-prod.yml?logo=github&style=flat-square)](https://github.com/Crossbell-Box/xLog/actions/workflows/docker-build-push.yml) +## Introduction + +xLog is a blogging platform that runs on the Crossbell blockchain. It is open source, decentralized, and free. It is a community of bloggers who share their thoughts and ideas with each other. It is a place where you can find the latest news and trends of Web2, Web3, and the real world. + ## Features -![](https://raw.githubusercontent.com/Crossbell-Box/xLog/dev/public/assets/overall.png) +![](https://i.imgur.com/S0PbFjg.png) -### Easy +## Contributors -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. +xLog is a growing community and is always accepting new contributors. There's a lot of different ways to help out and we're always looking for extra hands! -![](https://raw.githubusercontent.com/Crossbell-Box/xLog/dev/public/assets/easy.png) +Detailed information about how to contribute can be found in the [contribution guide](https://github.com/Crossbell-Box/xLog/blob/dev/CONTRIBUTING.md) -### Safe +## Related projects -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. - -![](https://raw.githubusercontent.com/Crossbell-Box/xLog/dev/public/assets/safe.png) - -### Fast - -Blockchain doesn't always mean inefficiency. xLog's efficient caching mechanism and numerous optimisations take it to the peak of performance. - -![](https://raw.githubusercontent.com/Crossbell-Box/xLog/dev/public/assets/fast.png) - -### Customizable - -Use your own domain, customise your site and style it however you like. This is your site, there are no restrictions. - -![](https://raw.githubusercontent.com/Crossbell-Box/xLog/dev/public/assets/customizable.png) - -### 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. - -![](https://raw.githubusercontent.com/Crossbell-Box/xLog/dev/public/assets/open.png) - -## Integration - -xLog's open design allows it to integrate with many other open protocols and applications without friction. - -![](https://i.imgur.com/lH9Tmgn.png) - -## 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) +- [proselog](https://github.com/proselog/proselog): xLog is developed based on proselog. +- [Crossbell](https://github.com/Crossbell-Box): The blockchain and its supporting facilities on which xLog operates. +- [Mix Space](https://github.com/mx-space): Another excellent blogging platform integrated with xLog. +- [xLog mobile](https://github.com/Crossbell-Box/xLog-mobile): The mobile app for xLog.