Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nodetec/ublog
A minimalist blog on nostr that allows anyone to easily create their own personal micro-blog.
https://github.com/nodetec/ublog
blog nostr
Last synced: about 1 month ago
JSON representation
A minimalist blog on nostr that allows anyone to easily create their own personal micro-blog.
- Host: GitHub
- URL: https://github.com/nodetec/ublog
- Owner: nodetec
- License: gpl-3.0
- Created: 2023-02-26T00:26:27.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2024-03-10T14:56:17.000Z (9 months ago)
- Last Synced: 2024-05-10T05:03:26.051Z (7 months ago)
- Topics: blog, nostr
- Language: TypeScript
- Homepage: https://u-blog.vercel.app
- Size: 3.24 MB
- Stars: 23
- Watchers: 1
- Forks: 15
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-nostr - uBlog - A minimalist blog on nostr that allows anyone to easily create their own personal micro-blog. (Clients / Relay lists)
README
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![GPL-3.0 License][license-shield]][license-url]
µ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
-
About The Project
-
Getting Started
-
Configuration
- Roadmap
- Contributing
- License
- Contact
- Acknowledgments
## About The Project
[![Product Name Screen Shot][product-screenshot]](https://example.com)
WIP
### Built With
- [![Next][Next.js]][Next-url]
## Getting Started
1. Fork this repo
2. Edit `ublog.config.js`
3. Deploy on vercel
## Configuration
The [`ublog.config.js`](https://github.com/nodetec/ublog/blob/master/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](https://daisyui.com/theme-generator/). | Required |
| `relays` | An array of relays. | Required |
Note:
- At least one value is required between `themes` and `customThemes`.
## Roadmap
- [x] Implement settings page
- [x] Implement write page
- [x] Implement publish button
- [x] Implement loading ui
- [x] Implement lightning tips
- [x] Implement tags
See the [open issues](https://github.com/nodetec/ublog/issues) for a full list of proposed features (and known issues).
## 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
## License
Distributed under the GPL-3.0 License. See `LICENSE.txt` for more information.
## Contact
Discord - [https://discord.gg/Xb9B4Ny](https://discord.gg/Xb9B4Ny)
Project Link: [https://github.com/nodetec/ublog](https://github.com/nodetec/ublog)
## Acknowledgments
- [nostr](https://github.com/nostr-protocol/nostr)
- [blogstack.io](https://github.com/nodetec/blogstack)
- [Best-README-Template](https://github.com/othneildrew/Best-README-Template/blob/master/README.md)
[contributors-shield]: https://img.shields.io/github/contributors/nodetec/ublog.svg?style=for-the-badge
[contributors-url]: https://github.com/nodetec/ublog/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/nodetec/ublog.svg?style=for-the-badge
[forks-url]: https://github.com/nodetec/ublog/network/members
[stars-shield]: https://img.shields.io/github/stars/nodetec/ublog.svg?style=for-the-badge
[stars-url]: https://github.com/nodetec/ublog/stargazers
[issues-shield]: https://img.shields.io/github/issues/nodetec/ublog.svg?style=for-the-badge
[issues-url]: https://github.com/nodetec/ublog/issues
[license-shield]: https://img.shields.io/github/license/nodetec/ublog.svg?style=for-the-badge
[license-url]: https://github.com/nodetec/ublog/blob/master/LICENSE.txt
[product-screenshot]: images/screenshot.png
[Next.js]: https://img.shields.io/badge/next.js-000000?style=for-the-badge&logo=nextdotjs&logoColor=white
[Next-url]: https://nextjs.org/