Skip to content

Latest commit

 

History

History
194 lines (141 loc) · 7.27 KB

README.md

File metadata and controls

194 lines (141 loc) · 7.27 KB
Raw

Contributors Forks Stargazers Issues GPL-3.0 License


Logo

µBlog

uBlog is a minimalist blog on nostr that allows anyone to easily create their own personal micro-blog.

👁️ View Demo · 🐞 Report Bug

Table of Contents
  1. About The Project
  2. Getting Started
  3. Configuration
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

Product Name Screen Shot

WIP

(back to top)

Built With

  • Next

(back to top)

Getting Started

  1. Fork this repo
  2. Edit ublog.config.js
  3. Deploy on vercel

Configuration

The ublog.config.js file contains the configuration settings for this project

Option Description Required/Optional
title The title of your blog. Required
description A brief description of your blog. Required
favicon The URL of the favicon image for your blog. Optional
logo The URL of the logo image for your blog. Optional
npub Your own public key for your blog. Required
themes An array of built-in themes. Choose your favorite themes. Required
customThemes An array of custom themes. You can generate your own theme from here. Required
relays An array of relays. Required

Note:

  • At least one value is required between themes and customThemes.

Roadmap

  • Implement settings page
  • Implement write page
    • Implement publish button
  • Implement loading ui
  • Implement lightning tips
  • Implement tags

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the GPL-3.0 License. See LICENSE.txt for more information.

(back to top)

Contact

Discord - https://discord.gg/Xb9B4Ny

Project Link: https://github.com/nodetec/ublog

(back to top)

Acknowledgments

(back to top)