Skip to content

Commit

Permalink
add nodejs, python, ipykernel instruction; remove gallery
Browse files Browse the repository at this point in the history
  • Loading branch information
lihebi committed Oct 31, 2023
1 parent 2eda968 commit df31f56
Showing 1 changed file with 16 additions and 7 deletions.
23 changes: 16 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,34 +14,43 @@ overwhelmed by the great number of code snippets as the projects grow.

![screenshot](./screenshot-canvas.png)

# Gallery
<!-- # Gallery
Thanks to our community, we now have CodePod showcases ranging from analytical geometry to bioinformatics.
- [plotting common functions](https://app.codepod.io/repo/2ncnioylo9abo3otdxjs)
- [image operations using skimage](https://user-images.githubusercontent.com/44469195/239033643-decbd7ae-29bb-44b9-af33-d4cb7c2bce46.png)
- [tel-siRNA sequence detector](https://app.codepod.io/repo/b94n7n00a9395xwhv1o8)
- [tel-siRNA sequence detector](https://app.codepod.io/repo/b94n7n00a9395xwhv1o8) -->

# Install

You can install codepod CLI app with npm::
Step 1: install prerequisite: [nodejs](https://nodejs.org/en/download) runtime
and python & ipykernel:

```
brew install node # example for MacOS
pip3 install ipykernel
```

Step 2: Install codepod CLI app from [npm registry](https://www.npmjs.com/package/codepod):

```
> npm install -g codepod
> codepod --version
# 0.0.7
```

You can use it like this:
Step 3: launch CodePod from terminal:

```
> codepod /path/to/repo
> codepod /path/to/local/repo
# ... 🚀 Server ready at http://localhost:4001
```

Open this URL in your browser to see the app. The files will be saved to the directory `/path/to/repo/.codepod/yjs.[bin|json]`.
Open this URL in your browser to see the app. The files will be saved to the
directory `/path/to/repo/.codepod/yjs.[bin|json]`.

Update the app:
In the future, you can update the app:

```
> npm update -g codepod
Expand Down

0 comments on commit df31f56

Please sign in to comment.