Skip to content

Commit

Permalink
Updated package.json and README for the first release.
Browse files Browse the repository at this point in the history
  • Loading branch information
keiono committed Jan 30, 2025
1 parent 0c72d8d commit 162d5f0
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 3 deletions.
18 changes: 16 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,17 +21,31 @@ The production version is available here:

Cytoscape Web is designed to expand with two types of **Apps**. We are actively researching and developing examples. Please visit the following pages for more details:

- https://github.com/cytoscape/cytoscape-web-app-examples
- [App examples](https://github.com/cytoscape/cytoscape-web-app-examples)
- [Service-based app developer guide](<https://github.com/cytoscape/cytoscape-web/wiki/Specification-for-Service-App-in-Cytoscape-Web-(draft-v2)>)

# Developer's Guide

(TBA)

! The following section is not finished yet.
## Quick Start

Cytoscape Web is designed to have minimum dependency to the backend services,
so you can easily run your own instance locally only with an HTTP server.

To run Cytoscape Web locally with development http server, checkout this repository and run the following:

```
npm install
npm run dev
```

This will start a local test server and opens a new browser tab.

---

! The following section is not finished yet.

### Build dependencies

Install `node` and `npm`. The easiest way is to download both from [offical website](https://nodejs.org/en/).
Expand Down
19 changes: 18 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,25 @@
{
"name": "cytoscape-web",
"version": "1.0.0-beta.1",
"version": "1.0.0",
"private": true,
"license": "MIT",
"keywords": [
"cytoscape",
"graph",
"network",
"visualization",
"bioinformatics"
],
"description": "Cytoscape Web: A web-based network visualization tool for modern web browsers",
"author": {
"name": "The Cytoscape Consortium",
"url": "https://cytoscape.org"
},
"homepage": "http://web.cytoscape.org",
"repository": {
"type": "git",
"url": "https://github.com/cytoscape/cytoscape-web.git"
},
"scripts": {
"clean": "rm -rf dist",
"test": "npm run test:playwright && npm run test:unit",
Expand Down

0 comments on commit 162d5f0

Please sign in to comment.