Skip to content

Latest commit

 

History

History
79 lines (54 loc) · 2.14 KB

README.md

File metadata and controls

79 lines (54 loc) · 2.14 KB
Raw

This is a fork of coreui-nostr-free-react-admin-template. That template retains all of the pages from coreui-free-react-admin-template, which demo all that the template is capable of. In this repo, extraneous pages that are unrelated to nostr will be deleted, and the basic nostr functions will be expanded upon and polished a bit, with several pages added, including:

  • view active relays
  • view my follows
  • view profile of other users
  • store my kind 1 notes in redux and display them (event.id only, nothing fancy)

Deploy

To deploy this to Vercel: clone this template to your github account, connect your Vercel account to your github account, and follow the instructions:

  • Go to your Vercel account, find Add New Project. Should see option to Import Git Repository. Select the repo from your github account.

Use these options:

  • Framework Preset is Vite. (automatically)
  • Did NOT select src as the root directory, just left it as it is.
  • Under Build and Output Settings, next to Output Directory, click Override and replace dist with build.
  • Under Install Command, click Override and enter npm install (not sure if this is necessary)
  • No Environmental Variables.
  • Click Deploy.

Run Locally

To run on your machine locally:

Clone

$ git clone https://github.com/wds4/coreui-nostr-free-react-admin-template-b.git
$ cd coreui-nostr-free-react-admin-template-b

Installation

$ npm install

or

$ yarn install

Basic usage

# dev server with hot reload at http://localhost:3000
$ npm start

or

# dev server with hot reload at http://localhost:3000
$ yarn start

Navigate to http://localhost:3000. The app will automatically reload if you change any of the source files.

Build

Run build to build the project. The build artifacts will be stored in the build/ directory.

# build for production with minification
$ npm run build

or

# build for production with minification
$ yarn build

License

Code released under the MIT license.