nostr/primal-web-app
1
0
Fork 0
mirror of https://github.com/PrimalHQ/primal-web-app.git synced 2024-09-29 00:10:50 +00:00
Code Issues Packages Projects Releases Wiki Activity
Primal's web app for Nostr, as experienced on primal.net.
33 Commits 8 Branches 4 Tags 16 MiB
TypeScript 78%
SCSS 21.7%
CSS 0.2%
a866038dcb
Go to file
Bojan Mojsilovic a866038dcb Preliminary: Add note to thread after replying
2023-07-21 14:51:37 +02:00
.github/ISSUE_TEMPLATE Implemented vanity project README and added CONTRIBUTING.md and templates for bug reports and feature requests 2023-07-12 18:11:27 +02:00
public/public Modify downloads page with a mobile promo video 2023-07-17 18:28:06 +02:00
src Preliminary: Add note to thread after replying 2023-07-21 14:51:37 +02:00
.env Use priority relays if configured 2023-07-20 17:48:07 +02:00
.gitignore Implemented vanity project README and added CONTRIBUTING.md and templates for bug reports and feature requests 2023-07-12 18:11:27 +02:00
CONTRIBUTING.md Implemented vanity project README and added CONTRIBUTING.md and templates for bug reports and feature requests 2023-07-12 18:11:27 +02:00
fonts-google.css Opening my eyes 2023-07-07 16:14:22 +02:00
index.html Change Primal description and image metadata 2023-07-11 16:22:04 +02:00
LICENSE Opening my eyes 2023-07-07 16:14:22 +02:00
package-lock.json Update notstr-tools 2023-07-12 16:33:23 +02:00
package.json Bumped version to 1.0.0 2023-07-12 18:11:27 +02:00
README.md Update README with env variable instructions 2023-07-14 13:01:25 +02:00
tsconfig.json Opening my eyes 2023-07-07 16:14:22 +02:00
vite.config.ts Add support for env variables PRIMAL_CACHE_URL and PRIMAL_UPLOAD_URL. 2023-07-13 12:47:25 +02:00

README.md

Contributors Forks Stargazers Issues MIT License


Logo

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
  2. Getting Started
  3. Contributing
  4. License
  5. Contact

About The Project

iPhone Screenshot

(back to top)

Built With

Solidjs

Typescript

Sass

(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

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

(back to top)