mirror of
https://github.com/waku-org/js-waku.git
synced 2025-02-02 15:44:08 +00:00
Rename repo to waku-js
This commit is contained in:
Franck Royer
parent
702201f7be
commit
82d026c6d5
4
.github/workflows/add-action-project.yml
vendored
4
.github/workflows/add-action-project.yml
vendored
@ -1,4 +1,4 @@
|
||||
name: Add new issues to js-waku project board
|
||||
name: Add new issues to waku-js project board
|
||||
|
||||
on:
|
||||
issues:
|
||||
@ -10,6 +10,6 @@ jobs:
|
||||
steps:
|
||||
- uses: alex-page/github-project-automation-plus@v0.6.0
|
||||
with:
|
||||
project: js-waku
|
||||
project: waku-js
|
||||
column: New
|
||||
repo-token: ${{ secrets.GH_ACTION_PROJECT_MGMT }}
|
||||
|
||||
6
.github/workflows/deploy-gh-pages.yml
vendored
6
.github/workflows/deploy-gh-pages.yml
vendored
@ -15,7 +15,7 @@ jobs:
|
||||
|
||||
- name: Set git author identity
|
||||
run: |
|
||||
git config user.name "GitHub Action On js-waku Repo"
|
||||
git config user.name "GitHub Action On waku-js Repo"
|
||||
git config user.email "franck+ghpages@status.im"
|
||||
|
||||
- name: Install NodeJS
|
||||
@ -29,10 +29,10 @@ jobs:
|
||||
path: ~/.npm
|
||||
key: node-v1-${{ hashFiles('**/package-lock.json') }}
|
||||
|
||||
- name: "[js-waku] install using npm ci"
|
||||
- name: "[waku-js] install using npm ci"
|
||||
uses: bahmutov/npm-install@v1
|
||||
|
||||
- name: "[js-waku] build"
|
||||
- name: "[waku-js] build"
|
||||
run: npm run build
|
||||
|
||||
- name: install using npm i
|
||||
|
||||
4
.github/workflows/examples-ci.yml
vendored
4
.github/workflows/examples-ci.yml
vendored
@ -30,10 +30,10 @@ jobs:
|
||||
path: ~/.npm
|
||||
key: examples-node-v1-${{ hashFiles('**/package-lock.json') }}
|
||||
|
||||
- name: "[js-waku] install using npm ci"
|
||||
- name: "[waku-js] install using npm ci"
|
||||
uses: bahmutov/npm-install@v1
|
||||
|
||||
- name: "[js-waku] build"
|
||||
- name: "[waku-js] build"
|
||||
run: npm run build
|
||||
|
||||
- name: ${{ matrix.example }} install using npm i
|
||||
|
||||
@ -2,10 +2,10 @@
|
||||
|
||||
Contributors are welcomed!
|
||||
|
||||
We try to keep a number of [`good first issue`](https://github.com/status-im/js-waku/labels/good%20first%20issue) for new contributors.
|
||||
If you feel confident, you can also check out the [`help wanted`](https://github.com/status-im/js-waku/labels/help%20wanted) issues.
|
||||
We try to keep a number of [`good first issue`](https://github.com/status-im/waku-js/labels/good%20first%20issue) for new contributors.
|
||||
If you feel confident, you can also check out the [`help wanted`](https://github.com/status-im/waku-js/labels/help%20wanted) issues.
|
||||
|
||||
To have an idea of the work in the pipeline, feel free to view the [js-waku project board](https://github.com/status-im/js-waku/projects/1).
|
||||
To have an idea of the work in the pipeline, feel free to view the [waku-js project board](https://github.com/status-im/waku-js/projects/1).
|
||||
This project board is to prioritize the work of core contributors so do not be deterred by issues in the `Icebox` or bottom of the `Backlog`.
|
||||
|
||||
Do note that we have a [CI](./.github/workflows/ci.yml) powered by GitHub Action.
|
||||
@ -25,7 +25,7 @@ To build and test this repository, you need:
|
||||
|
||||
To ensure interoperability with [nim-waku](https://github.com/status-im/nim-waku/), some tests are run against a nim-waku node.
|
||||
This is why `nim-waku` is present as a [git submodule](https://git-scm.com/book/en/v2/Git-Tools-Submodules), which itself contain several submodules.
|
||||
At this stage, it is not possible to exclude nim-waku tests, hence `git submodule update --init --recursive` is run before testing (see [`pretest` script](https://github.com/status-im/js-waku/blob/main/package.json)).
|
||||
At this stage, it is not possible to exclude nim-waku tests, hence `git submodule update --init --recursive` is run before testing (see [`pretest` script](https://github.com/status-im/waku-js/blob/main/package.json)).
|
||||
|
||||
To build nim-waku, you also need [Rust](https://www.rust-lang.org/tools/install).
|
||||
|
||||
|
||||
28
README.md
28
README.md
@ -76,7 +76,7 @@ waku.store.queryHistory(storePeerId, ["waku/2/my-cool-app/proto"],
|
||||
```
|
||||
|
||||
Find more [examples](#examples) below
|
||||
or checkout the latest `main` branch documentation at [https://status-im.github.io/js-waku/docs/](https://status-im.github.io/js-waku/docs/).
|
||||
or checkout the latest `main` branch documentation at [https://status-im.github.io/waku-js/docs/](https://status-im.github.io/waku-js/docs/).
|
||||
|
||||
Docs can also be generated locally using:
|
||||
|
||||
@ -87,7 +87,7 @@ npm run doc
|
||||
|
||||
## Waku Protocol Support
|
||||
|
||||
You can track progress on the [project board](https://github.com/status-im/js-waku/projects/1).
|
||||
You can track progress on the [project board](https://github.com/status-im/waku-js/projects/1).
|
||||
|
||||
- ✔: Supported
|
||||
- 🚧: Implementation in progress
|
||||
@ -111,28 +111,28 @@ You can track progress on the [project board](https://github.com/status-im/js-wa
|
||||
|
||||
## Bugs, Questions & Features
|
||||
|
||||
If you encounter any bug or would like to propose new features, feel free to [open an issue](https://github.com/status-im/js-waku/issues/new/).
|
||||
If you encounter any bug or would like to propose new features, feel free to [open an issue](https://github.com/status-im/waku-js/issues/new/).
|
||||
|
||||
For support, questions & more general topics, please join the discussion on the [Vac forum](https://forum.vac.dev/tag/js-waku) (use _\#js-waku_ tag).
|
||||
For support, questions & more general topics, please join the discussion on the [Vac forum](https://forum.vac.dev/tag/waku-js) (use _\#js-waku_ tag).
|
||||
|
||||
## Examples
|
||||
|
||||
## Web Chat App (ReactJS)
|
||||
|
||||
A ReactJS chat app is provided as a showcase of the library used in the browser.
|
||||
A deployed version is available at https://status-im.github.io/js-waku/
|
||||
A deployed version is available at https://status-im.github.io/waku-js/
|
||||
|
||||
Find the code in the [examples folder](https://github.com/status-im/js-waku/tree/main/examples/web-chat).
|
||||
Find the code in the [examples folder](https://github.com/status-im/waku-js/tree/main/examples/web-chat).
|
||||
|
||||
To run a development version locally, do:
|
||||
|
||||
```shell
|
||||
git clone https://github.com/status-im/js-waku/ ; cd js-waku
|
||||
npm install # Install dependencies for js-waku
|
||||
npm run build # Build js-waku
|
||||
git clone https://github.com/status-im/waku-js/ ; cd waku-js
|
||||
npm install # Install dependencies for waku-js
|
||||
npm run build # Build waku-js
|
||||
cd examples/web-chat
|
||||
npm install # Install dependencies for the web app
|
||||
npm run start # Start development server to serve the web app on http://localhost:3000/js-waku
|
||||
npm run start # Start development server to serve the web app on http://localhost:3000/waku-js
|
||||
```
|
||||
|
||||
Use `/help` to see the available commands.
|
||||
@ -142,7 +142,7 @@ Use `/help` to see the available commands.
|
||||
A node chat app is provided as a working example of the library.
|
||||
It is interoperable with the [nim-waku chat app example](https://github.com/status-im/nim-waku/blob/master/examples/v2/chat2.nim).
|
||||
|
||||
Find the code in the [examples folder](https://github.com/status-im/js-waku/tree/main/examples/cli-chat).
|
||||
Find the code in the [examples folder](https://github.com/status-im/waku-js/tree/main/examples/cli-chat).
|
||||
|
||||
To run the chat app, first ensure you have [Node.js](https://nodejs.org/en/) v14 or above:
|
||||
|
||||
@ -153,9 +153,9 @@ node --version
|
||||
Then, install and run:
|
||||
|
||||
```shell
|
||||
git clone https://github.com/status-im/js-waku/ ; cd js-waku
|
||||
npm install # Install dependencies for js-waku
|
||||
npm run build # Build js-waku
|
||||
git clone https://github.com/status-im/waku-js/ ; cd waku-js
|
||||
npm install # Install dependencies for waku-js
|
||||
npm run build # Build waku-js
|
||||
cd examples/cli-chat
|
||||
npm install # Install dependencies for the cli app
|
||||
npm run start -- --staticNode /ip4/134.209.139.210/tcp/30303/p2p/16Uiu2HAmPLe7Mzm8TsYUubgCAW1aJoeFScxrLj8ppHFivPo97bUZ
|
||||
|
||||
@ -1,3 +1,3 @@
|
||||
# A NodeJS CLI Chat App powered by js-waku
|
||||
# A NodeJS CLI Chat App powered by waku-js
|
||||
|
||||
See js-waku [README](../../README.md#cli-chat-app-nodejs) for details.
|
||||
See waku-js [README](../../README.md#cli-chat-app-nodejs) for details.
|
||||
|
||||
4
examples/cli-chat/package-lock.json
generated
4
examples/cli-chat/package-lock.json
generated
@ -1,11 +1,11 @@
|
||||
{
|
||||
"name": "js-waku-cli-chat",
|
||||
"name": "waku-js-cli-chat",
|
||||
"version": "0.1.0",
|
||||
"lockfileVersion": 2,
|
||||
"requires": true,
|
||||
"packages": {
|
||||
"": {
|
||||
"name": "js-waku-cli-chat",
|
||||
"name": "waku-js-cli-chat",
|
||||
"version": "0.1.0",
|
||||
"license": "MIT OR Apache-2.0",
|
||||
"dependencies": {
|
||||
|
||||
@ -1,9 +1,9 @@
|
||||
{
|
||||
"name": "js-waku-cli-chat",
|
||||
"name": "waku-js-cli-chat",
|
||||
"version": "0.1.0",
|
||||
"description": "A NodeJS CLI Chat App powered by js-waku",
|
||||
"description": "A NodeJS CLI Chat App powered by waku-js",
|
||||
"main": "./index.ts",
|
||||
"repository": "https://github.com/status-im/js-waku",
|
||||
"repository": "https://github.com/status-im/waku-js",
|
||||
"license": "MIT OR Apache-2.0",
|
||||
"keywords": [
|
||||
"waku",
|
||||
|
||||
@ -25,7 +25,7 @@ export default async function startChat(): Promise<void> {
|
||||
output: process.stdout,
|
||||
});
|
||||
|
||||
let nick = 'js-waku';
|
||||
let nick = 'waku-js';
|
||||
try {
|
||||
const question = util.promisify(rl.question).bind(rl);
|
||||
// Looks like wrong type definition of promisify is picked.
|
||||
|
||||
@ -1,3 +1,3 @@
|
||||
# A React Web Chat App powered by js-waku
|
||||
# A React Web Chat App powered by waku-js
|
||||
|
||||
See js-waku [README](../../README.md#web-chat-app-reactjs) for details.
|
||||
See waku-js [README](../../README.md#web-chat-app-reactjs) for details.
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
"name": "web-chat",
|
||||
"version": "0.1.0",
|
||||
"private": true,
|
||||
"homepage": "/js-waku",
|
||||
"homepage": "/waku-js",
|
||||
"dependencies": {
|
||||
"@livechat/ui-kit": "*",
|
||||
"react": "^16.14.0",
|
||||
@ -38,8 +38,8 @@
|
||||
"test:spelling": "cspell \"{README.md,.github/*.md,src/**/*.{ts,tsx},public/**/*.html}\" -c ../../.cspell.json",
|
||||
"fix:prettier": "prettier \"src/**/*.{ts,tsx}\" \"./*.json\" --write",
|
||||
"fix:lint": "eslint src --ext .ts --ext .tsx --fix",
|
||||
"js-waku:build": "cd ../; npm run build",
|
||||
"predeploy": "run-s js-waku:build build",
|
||||
"waku-js:build": "cd ../; npm run build",
|
||||
"predeploy": "run-s waku-js:build build",
|
||||
"deploy": "gh-pages -d build"
|
||||
},
|
||||
"eslintConfig": {
|
||||
|
||||
@ -7,7 +7,7 @@
|
||||
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,500,700&display=swap" />
|
||||
<meta
|
||||
name="description"
|
||||
content="Chat app powered by js-waku"
|
||||
content="Chat app powered by waku-js"
|
||||
/>
|
||||
<!--
|
||||
manifest.json provides metadata used when your web app is installed on a
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
{
|
||||
"short_name": "Waku v2 chat app",
|
||||
"name": "Chat app powered by js-waku",
|
||||
"name": "Chat app powered by waku-js",
|
||||
"icons": [
|
||||
{
|
||||
"src": "favicon.ico",
|
||||
|
||||
@ -5,7 +5,7 @@
|
||||
"main": "build/main/index.js",
|
||||
"typings": "build/main/index.d.ts",
|
||||
"module": "build/module/index.js",
|
||||
"repository": "https://github.com/status-im/js-waku",
|
||||
"repository": "https://github.com/status-im/waku-js",
|
||||
"license": "MIT OR Apache-2.0",
|
||||
"keywords": [
|
||||
"waku",
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user