license and readme, also remove author pubkey

This commit is contained in:
austinkelsay 2024-11-17 17:49:33 -06:00
parent f08a6c9161
commit 05f3a4a3bb
No known key found for this signature in database
GPG Key ID: 44CB4EC6D9F2FA02
3 changed files with 100 additions and 3 deletions

21
LICENSE Normal file
View File

@ -0,0 +1,21 @@
MIT License
Copyright (c) 2024 PlebDevs
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

View File

@ -1,3 +1,79 @@
# Plebdevs
# PlebDevs ⚡️
plebdevs.com
A one-of-a-kind developer education, content, and community platform built on Nostr and fully Lightning integrated.
<br />[https://plebdevs.com](https://plebdevs.com)
## Overview
PlebDevs is an open-source platform that combines educational content, community interaction, and Bitcoin/Lightning integration. The platform publishes content to Nostr and actively pulls from Nostr relays, creating a distributed, interoperable, trail of Documents, Videos, and Courses.
## Key Features
- ☁️ **Content Distribution**: All content is published to Nostr and pulled from Nostr relays
- 📝 **Content Types**:
- Documents (NIP-23 long-form) - Markdown-based educational content
- Videos with rich media support - Including embedded video content
- Structured courses (NIP-51) - Combining multiple documents and videos into learning paths
- ⚡️ **Monetization**:
- Free content available to all (viewable on any Nostr client) and zappable
- Premium content purchasable with Lightning or through a PlebDevs subscription
- Subscription options:
- Pay-as-you-go: 70,000 sats - One-time payment for one month of access
- Recurring: 70,000 sats/month - Automatic renewal via Nostr Wallet Connect
- ⭐️ **Subscription Benefits**:
- Full access to all paid content
- 1:1 calendar for tutoring/help
- Custom PlebDevs.com Lightning Address
- Custom PlebDevs.com Nostr NIP-05 identity
- 👥 **Community Features**:
- Nostr-based chat (Read/Write)
- Discord integration (Read Only)
- StackerNews ~devs territory integration (Read Only)
## Tech Stack
### Frontend ⚛️
- [Next.js](https://nextjs.org/)
- [Tailwind CSS](https://tailwindcss.com/)
- [PrimeReact](https://primereact.org/)
### Backend 🔧
- [Prisma](https://www.prisma.io/)
- [PostgreSQL](https://www.postgresql.org/)
- [Redis](https://redis.io/)
### Infrastructure ⚙️
- [Vercel](https://vercel.com/)
- [Docker](https://www.docker.com/)
- [Digital Ocean](https://www.digitalocean.com/)
### Bitcoin & Nostr Integration 🔌
- [NDK](https://github.com/nostr-dev-kit/ndk)
- [nostr-tools](https://github.com/nbd-wtf/nostr-tools)
- [Bitcoin-Connect](https://github.com/getAlby/bitcoin-connect)
- [Alby JS SDK](https://github.com/getAlby/js-sdk)
- [ZapThreads](https://github.com/franzaps/zapthreads)
- [Zapper](https://github.com/nostrband/zapper)
## Contributing
Contributions are welcome! Whether you're fixing bugs, improving documentation, or proposing new features, please feel free to open an issue or submit a PR.
## Running Locally
Coming soon...
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## Connect with Us 🤝
- 💻 [GitHub](https://github.com/austinkelsay/plebdevs)
- 🐦 [Twitter/X](https://x.com/pleb_devs)
- 🟣 [Nostr](https://nostr.com/plebdevs@plebdevs.com)
- 📺 [YouTube](https://www.youtube.com/@plebdevs)
## Support the Project ⚡️
Lightning Address: plebdevs@plebdevs.com

View File

@ -11,7 +11,7 @@ const appConfig = {
"wss://purplerelay.com/",
"wss://relay.devs.tools/"
],
authorPubkeys: ["f33c8a9617cb15f705fc70cd461cfd6eaf22f9e24c33eabad981648e5ec6f741", "c67cd3e1a83daa56cff16f635db2fdb9ed9619300298d4701a58e68e84098345", "468f729dd409053dac5e7470622c3996aad88db6ed1de9165cb1921b5ab4fd5e"],
authorPubkeys: ["f33c8a9617cb15f705fc70cd461cfd6eaf22f9e24c33eabad981648e5ec6f741", "c67cd3e1a83daa56cff16f635db2fdb9ed9619300298d4701a58e68e84098345"],
customLightningAddresses: [
{
// todo remove need for lowercase