mirror of
https://github.com/t4t5/nostr-react.git
synced 2025-03-17 21:41:42 +01:00
Add basic README
This commit is contained in:
Tristan Edwards
parent
95ae00a277
commit
7c13a5d2bc
221
README.md
221
README.md
@ -1,160 +1,119 @@
|
||||
# DTS React User Guide
|
||||
# @nostrgg/react
|
||||
|
||||
Congrats! You just saved yourself hours of work by bootstrapping this project with DTS. Let’s get you oriented with what’s here and how to use it.
|
||||
React Hooks for Nostr
|
||||
|
||||
> This DTS setup is meant for developing React component libraries (not apps!) that can be published to NPM. If you’re looking to build a React-based app, you should use `create-react-app`, `razzle`, `nextjs`, `gatsby`, or `react-static`.
|
||||
## Installation
|
||||
|
||||
> If you’re new to TypeScript and React, checkout [this handy cheatsheet](https://github.com/sw-yx/react-typescript-cheatsheet/)
|
||||
|
||||
## Commands
|
||||
|
||||
DTS scaffolds your new library inside `/src`, and also sets up a [Vite-based](https://vitejs.dev) playground for it inside `/example`.
|
||||
|
||||
The recommended workflow is to run DTS in one terminal:
|
||||
|
||||
```bash
|
||||
npm start # or yarn start
|
||||
```
|
||||
npm install @nostrgg/react
|
||||
```
|
||||
|
||||
This builds to `/dist` and runs the project in watch mode so any edits you save inside `src` causes a rebuild to `/dist`.
|
||||
## Example usage:
|
||||
|
||||
Then run the example inside another:
|
||||
Wrap your app in the NostrProvider:
|
||||
|
||||
```bash
|
||||
cd example
|
||||
npm i # or yarn to install dependencies
|
||||
npm start # or yarn start
|
||||
```tsx
|
||||
import { NostrProvider } from "@nostrgg/react";
|
||||
|
||||
const relayUrls = [
|
||||
"wss://nostr-pub.wellorder.net",
|
||||
"wss://nostr-relay.untethr.me",
|
||||
];
|
||||
|
||||
function MyApp() {
|
||||
return (
|
||||
<NostrProvider relayUrls={relayUrls}>
|
||||
<App />
|
||||
</NostrProvider>
|
||||
);
|
||||
};
|
||||
```
|
||||
|
||||
The default example imports and live reloads whatever is in `/dist`, so if you are seeing an out of date component, make sure DTS is running in watch mode like we recommend above.
|
||||
You can now use the `useNostr` and `useNostrEvents` hooks in your components!
|
||||
|
||||
To do a one-off build, use `npm run build` or `yarn build`.
|
||||
**Fetching all `text_note` events starting now:**
|
||||
|
||||
To run tests, use `npm test` or `yarn test`.
|
||||
```tsx
|
||||
import { Kind, useNostrEvents, dateToUnix } from "@nostrgg/react";
|
||||
|
||||
## Configuration
|
||||
const GlobalFeed = () => {
|
||||
const { isLoading, events } = useNostrEvents({
|
||||
filter: {
|
||||
kinds: [Kind.TextNote],
|
||||
since: dateToUnix(new Date()), // all new events from now
|
||||
},
|
||||
});
|
||||
|
||||
Code quality is set up for you with `prettier`, `husky`, and `lint-staged`. Adjust the respective fields in `package.json` accordingly.
|
||||
|
||||
### Jest
|
||||
|
||||
Jest tests are set up to run with `npm test` or `yarn test`.
|
||||
|
||||
### Bundle analysis
|
||||
|
||||
Calculates the real cost of your library using [size-limit](https://github.com/ai/size-limit) with `npm run size` and visulize it with `npm run analyze`.
|
||||
|
||||
#### Setup Files
|
||||
|
||||
This is the folder structure we set up for you:
|
||||
|
||||
```txt
|
||||
/example
|
||||
index.html
|
||||
index.tsx # test your component here in a demo app
|
||||
package.json
|
||||
tsconfig.json
|
||||
/src
|
||||
index.tsx # EDIT THIS
|
||||
/test
|
||||
index.test.tsx # EDIT THIS
|
||||
.gitignore
|
||||
package.json
|
||||
README.md # EDIT THIS
|
||||
tsconfig.json
|
||||
return (
|
||||
<>
|
||||
{events.map((event) => (
|
||||
<p key={event.id}>{event.pubkey} posted: {event.content}</p>
|
||||
))}
|
||||
</>
|
||||
);
|
||||
};
|
||||
```
|
||||
|
||||
#### React Testing Library
|
||||
**Fetching all `text_note` events from a specific user, since the beginning of time:**
|
||||
|
||||
We do not set up `react-testing-library` for you yet, we welcome contributions and documentation on this.
|
||||
```tsx
|
||||
import { Kind, useNostrEvents, dateToUnix } from "@nostrgg/react";
|
||||
|
||||
### Rollup
|
||||
const ProfileFeed = () => {
|
||||
const { events } = useNostrEvents({
|
||||
filter: {
|
||||
authors: [
|
||||
"9c2a6495b4e3de93f3e1cc254abe4078e17c64e5771abc676a5e205b62b1286c",
|
||||
],
|
||||
since: 0,
|
||||
kinds: [Kind.TextNote],
|
||||
},
|
||||
});
|
||||
|
||||
DTS uses [Rollup](https://rollupjs.org) as a bundler and generates multiple rollup configs for various module formats and build settings. See [Optimizations](#optimizations) for details.
|
||||
return (
|
||||
<>
|
||||
{events.map((event) => (
|
||||
<p key={event.id}>{event.pubkey} posted: {event.content}</p>
|
||||
))}
|
||||
</>
|
||||
);
|
||||
};
|
||||
```
|
||||
|
||||
### TypeScript
|
||||
**Post a message:**
|
||||
|
||||
`tsconfig.json` is set up to interpret `dom` and `esnext` types, as well as `react` for `jsx`. Adjust according to your needs.
|
||||
```tsx
|
||||
import {
|
||||
generateSignedEvent,
|
||||
Kind,
|
||||
SendMsgType,
|
||||
useNostr,
|
||||
} from "@nostrgg/react";
|
||||
|
||||
## Continuous Integration
|
||||
export default function PostButton() {
|
||||
const { sendEvent } = useNostr();
|
||||
|
||||
### GitHub Actions
|
||||
const onPost = async () => {
|
||||
const privKey = prompt("Paste your private key here:");
|
||||
|
||||
Two actions are added by default:
|
||||
if (!privKey) {
|
||||
alert("no private key provided");
|
||||
return;
|
||||
}
|
||||
|
||||
- `main` which installs deps w/ cache, lints, tests, and builds on all pushes against a Node and OS matrix
|
||||
- `size` which comments cost comparison of your library on every pull request using [`size-limit`](https://github.com/ai/size-limit)
|
||||
const event = {
|
||||
content: "Hello world!",
|
||||
kind: Kind.TextNote,
|
||||
tags: [],
|
||||
};
|
||||
|
||||
## Optimizations
|
||||
const signedEvent = await generateSignedEvent(event, privKey);
|
||||
|
||||
Please see the main `dts` [optimizations docs](https://github.com/weiran-zsd/dts-cli#optimizations). In particular, know that you can take advantage of development-only optimizations:
|
||||
sendEvent?.([SendMsgType.EVENT, signedEvent]);
|
||||
};
|
||||
|
||||
```js
|
||||
// ./types/index.d.ts
|
||||
declare var __DEV__: boolean;
|
||||
|
||||
// inside your code...
|
||||
if (__DEV__) {
|
||||
console.log('foo');
|
||||
return (
|
||||
<Button onClick={onPost}>Post a message!</Button>
|
||||
);
|
||||
}
|
||||
```
|
||||
|
||||
You can also choose to install and use [invariant](https://github.com/weiran-zsd/dts-cli#invariant) and [warning](https://github.com/weiran-zsd/dts-cli#warning) functions.
|
||||
|
||||
## Module Formats
|
||||
|
||||
CJS, ESModules, and UMD module formats are supported.
|
||||
|
||||
The appropriate paths are configured in `package.json` and `dist/index.js` accordingly. Please report if any issues are found.
|
||||
|
||||
## Deploying the Example Playground
|
||||
|
||||
The Playground is just a simple [Vite](https://vitejs.dev) app, you can deploy it anywhere you would normally deploy that. Here are some guidelines for **manually** deploying with the Netlify CLI (`npm i -g netlify-cli`):
|
||||
|
||||
```bash
|
||||
cd example # if not already in the example folder
|
||||
npm run build # builds to dist
|
||||
netlify deploy # deploy the dist folder
|
||||
```
|
||||
|
||||
Alternatively, if you already have a git repo connected, you can set up continuous deployment with Netlify:
|
||||
|
||||
```bash
|
||||
netlify init
|
||||
# build command: yarn build && cd example && yarn && yarn build
|
||||
# directory to deploy: example/dist
|
||||
# pick yes for netlify.toml
|
||||
```
|
||||
|
||||
## Named Exports
|
||||
|
||||
Per Palmer Group guidelines, [always use named exports.](https://github.com/palmerhq/typescript#exports) Code split inside your React app instead of your React library.
|
||||
|
||||
## Including Styles
|
||||
|
||||
There are many ways to ship styles, including with CSS-in-JS. DTS has no opinion on this, configure how you like.
|
||||
|
||||
For vanilla CSS, you can include it at the root directory and add it to the `files` section in your `package.json`, so that it can be imported separately by your users and run through their bundler's loader.
|
||||
|
||||
## Publishing to NPM
|
||||
|
||||
We recommend using [np](https://github.com/sindresorhus/np).
|
||||
|
||||
## Usage with Lerna
|
||||
|
||||
When creating a new package with DTS within a project set up with Lerna, you might encounter a `Cannot resolve dependency` error when trying to run the `example` project. To fix that you will need to make changes to the `package.json` file _inside the `example` directory_.
|
||||
|
||||
The problem is that due to the nature of how dependencies are installed in Lerna projects, the aliases in the example project's `package.json` might not point to the right place, as those dependencies might have been installed in the root of your Lerna project.
|
||||
|
||||
Change the `alias` to point to where those packages are actually installed. This depends on the directory structure of your Lerna project, so the actual path might be different from the diff below.
|
||||
|
||||
```diff
|
||||
"alias": {
|
||||
- "react": "../node_modules/react",
|
||||
- "react-dom": "../node_modules/react-dom"
|
||||
+ "react": "../../../node_modules/react",
|
||||
+ "react-dom": "../../../node_modules/react-dom"
|
||||
},
|
||||
```
|
||||
|
||||
An alternative to fixing this problem would be to remove aliases altogether and define the dependencies referenced as aliases as dev dependencies instead. [However, that might cause other problems.](https://github.com/formium/tsdx/issues/64)
|
||||
|
||||
@ -1,14 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="UTF-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<meta http-equiv="X-UA-Compatible" content="ie=edge" />
|
||||
<title>Playground</title>
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<div id="root"></div>
|
||||
<script type="module" src="./index.tsx"></script>
|
||||
</body>
|
||||
</html>
|
||||
@ -1,14 +0,0 @@
|
||||
import 'react-app-polyfill/ie11';
|
||||
import * as React from 'react';
|
||||
import * as ReactDOM from 'react-dom';
|
||||
import { Thing } from '../.';
|
||||
|
||||
const App = () => {
|
||||
return (
|
||||
<div>
|
||||
<Thing />
|
||||
</div>
|
||||
);
|
||||
};
|
||||
|
||||
ReactDOM.render(<App />, document.getElementById('root'));
|
||||
@ -1,26 +0,0 @@
|
||||
{
|
||||
"name": "example",
|
||||
"private": true,
|
||||
"version": "1.0.0",
|
||||
"main": "index.js",
|
||||
"license": "MIT",
|
||||
"scripts": {
|
||||
"start": "vite",
|
||||
"build": "vite build"
|
||||
},
|
||||
"dependencies": {
|
||||
"react-app-polyfill": "^3.0.0"
|
||||
},
|
||||
"alias": {
|
||||
"react": "../node_modules/react",
|
||||
"react-dom": "../node_modules/react-dom/profiling",
|
||||
"scheduler/tracing": "../node_modules/scheduler/tracing-profiling"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@types/react": "^17.0.47",
|
||||
"@types/react-dom": "^17.0.17",
|
||||
"vite": "latest",
|
||||
"vite-preset-react": "latest",
|
||||
"typescript": "^4"
|
||||
}
|
||||
}
|
||||
@ -1,3 +0,0 @@
|
||||
{
|
||||
"extends": "@tsconfig/create-react-app/tsconfig.json"
|
||||
}
|
||||
@ -1,11 +0,0 @@
|
||||
import { defineConfig } from 'vite';
|
||||
import ReactPlugin from 'vite-preset-react';
|
||||
|
||||
// https://vitejs.dev/config/
|
||||
export default defineConfig({
|
||||
plugins: [
|
||||
ReactPlugin({
|
||||
injectReact: false,
|
||||
}),
|
||||
],
|
||||
});
|
||||
Loading…
x
Reference in New Issue
Block a user