Skip to content

simple note-taking application built on the Internet Computer (ICP). This application allows users to create, read, and delete notes efficiently. The project uses Motoko for the backend and React with Vite for the frontend.

Notifications You must be signed in to change notification settings

triliun/dkeeper

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

dkeeper

dkeeper is a simple note-taking application built on the Internet Computer (ICP). This application allows users to create, read, and delete notes efficiently. The project uses Motoko for the backend and React with Vite for the frontend.

Features

  • Create Notes: Add new notes with a title and content.
  • Read Notes: View all created notes.
  • Delete Notes: Remove notes that are no longer needed.
  • Decentralized Storage: Data is securely stored on the Internet Computer.

preview

Getting Started

Before starting, ensure you have installed DFX and Node.js.

1. Clone the Repository

If you haven't already, clone this repository:

git clone https://github.com/triliun/dkeeper.git
cd dkeeper

2. Install Dependencies

Install the required dependencies for the project:

npm install

3. Start the Local Replica

Start the Internet Computer replica locally:

dfx start --background

4. Deploy Canisters

Deploy the backend and frontend canisters to the local replica:

dfx deploy

Once the deployment process is complete, the application will be available at:

http://localhost:4943?canisterId={asset_canister_id}

5. Run the Frontend Development Server

For frontend development, you can start the development server with:

npm start

The development server will run at http://localhost:3000.

Useful Commands

Generate Canister Declarations

To regenerate TypeScript/JavaScript declarations for the canister:

npm run generate

Stop the Replica

To stop the local replica:

dfx stop

Clean the Project

To remove canisters and local cache:

dfx clean

Frontend Environment Variables

If you are hosting the frontend in a production environment without DFX, ensure the following environment variables are set:

  • DFX_NETWORK: Set to ic for production.
  • CANISTER_ID: Frontend and backend canister IDs.

You can also replace process.env.DFX_NETWORK in the generated declarations by adding the following configuration to dfx.json:

"canisters": {
  "dkeeper_frontend": {
    "declarations": {
      "env_override": "ic"
    }
  }
}

Additional Documentation


About

simple note-taking application built on the Internet Computer (ICP). This application allows users to create, read, and delete notes efficiently. The project uses Motoko for the backend and React with Vite for the frontend.

Topics

Resources

Stars

Watchers

Forks