Skip to content

Latest commit

 

History

History
65 lines (40 loc) · 2.42 KB

README.md

File metadata and controls

65 lines (40 loc) · 2.42 KB
Raw

CanCan

Build Status

A scalable video-sharing service.

Installation

Prerequisites

If you don't have vessel yet you can install it by running an install script included in the project:

$ ./scripts/vessel-install.sh

MacOS might ask if you're sure you trust this package. You can safely accept

Double-check you have vessel installed at version 0.6.*, then clone this repository and navigate to the cancan directory.

$ vessel --version
# vessel 0.6.0

$ git clone git@github.com:dfinity/cancan.git
$ cd cancan

Start a local Internet Computer replica.

$ dfx start

Execute the following commands in another terminal tab in the same directory.

$ npm ci # <- This installs packages from the lockfile for consistency

$ ./bootstrap.sh

This will deploy a local canister called cancan_ui. To open the front-end, get the asset canister id by running dfx canister id cancan_ui. Then open your browser, and navigate to http://<cancan_ui-canister-id>.localhost:8000/sign-in.

Frontend Development

To run a development server with fast refreshing and hot-reloading, you can use this command in the app's root directory:

$ npm run start

Your default browser will open (or focus) a tab at localhost:3000, to which you must then append /?canisterId=${cancan_ui_canister_id}, where cancan_ui_canister_id is typically (at current) ryjl3-tyaaa-aaaaa-aaaba-cai.

Now you can make changes to any frontend code and see instant updates, in many cases not even requiring a page refresh, so UI state is preserved between changes. Occasionally adding a CSS rule won't trigger an update, and the user has to manually refresh to see those changes.

Internet Identity Locally

Clone and setup the project and make sure that internet_identity is deployed, and you have the front-end available. That should allow you to do auth locally to try out the new Internet Identity service. For production, we will probably configure identity.ic0.app to be running this canister, but for now this is how to get it running.