Primal

Featuring easy onboarding, fast & snappy UI, ability to explore Nostr, and create & manage custom feeds
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Setup
   • Development
3. Contributing
4. License
5. Contact

About The Project

(back to top)

Built With

(back to top)

Getting Started

Setup

Clone this repo then run the following commands:

• npm install (to install dependencies)
• npm run dev (to stand a local instance)

The caching service and the upload server urls can be configured with the following two environment variables which could be passed in via command line or read from the .env file:

• PRIMAL_CACHE_URL (caching service websocket url)
• PRIMAL_UPLOAD_URL (upload server websocket url)

Development

This code is still very much a work-in-progress. Expect major changes of the structure and logic to be happening somewhat frequently. Major features are still missing.

(back to top)

Contributing

Read more about contributions in CONTRIBUTING.md.

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

• Moysie - @moysie

Project Link: https://github.com/PrimalHQ/primal-web-app

(back to top)