aljaz/nashboard-old
1
1
Fork 0
mirror of https://github.com/vinliao/nashboard-old.git synced 2025-12-17 04:35:15 +01:00
Code Issues Packages Projects Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
Vincent Liao
2022-02-26 23:52:44 +07:00
parent c9595980be
commit 8b7cd14dfd
1 changed files with 3 additions and 39 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
README.md
View File

@@ -1,40 +1,4 @@
# create-svelte
# Relayed: a Nostr network dashboard
Firstly, I want to say thank you to relay operators. Without them, the Nostr network wouldn't run and this site wouldn't exist.
Everything you need to build a Svelte project, powered by [`create-svelte`](https://github.com/sveltejs/kit/tree/master/packages/create-svelte).
## Creating a project
If you're seeing this, you've probably already done this step. Congrats!
```bash
# create a new project in the current directory
npm init svelte@next
# create a new project in my-app
npm init svelte@next my-app
```
> Note: the `@next` is temporary
## Developing
Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server:
```bash
npm run dev
# or start the server and open the app in a new browser tab
npm run dev -- --open
```
## Building
To create a production version of your app:
```bash
npm run build
```
You can preview the production build with `npm run preview`.
> To deploy your app, you may need to install an [adapter](https://kit.svelte.dev/docs/adapters) for your target environment.
This small site displays basic statistics about the Nostr network - the events, the relays, the timestamps. You can think of it as the dashboard of the entire network.