mingderwang / selfid-next-notes-typescript

template in https://github.com/ceramicstudio/self.id.git

Notes application Next.js template for Self.ID with TypeScript

Using the Self.ID Framework with Next.js and TypeScript.

Getting Started

1. Copy this template

npx degit ceramicstudio/self.id/templates/next-notes-typescript my-selfid-app

Replace my-selfid-app by the folder name you want and access it once installed.

2. Install dependencies

In your application folder:

npm install
# or
yarn install

3. Publish the data model

This application uses a custom data model created by the create-model script. This model needs to be published to the Ceramic node before running the app.

npm run publish-model
# or
yarn run publish-model

4. Start the development server

npm run dev
# or
yarn run dev

Scripts

Use npm run or yarn run with one of the following scripts:

dev

Compile and run a development server.

build

Compile for production.

lint

Lint the source code.

start

Run a local server for production build.

publish-model

Run the publish-model script.

create-model

Run the create-model script.

This is only needed to make changes to the model used by the app. A hex-encoded 32-byte SEED environment variable must be present to create a key DID for the model when running the script.

Learn More

Learn more about data models, the Self.ID SDK and framework in the Ceramic documentation.

License

Dual licensed under MIT and Apache 2.