{"id":16548749,"url":"https://github.com/lizheming/animaris","last_synced_at":"2025-07-03T21:41:08.981Z","repository":{"id":55002148,"uuid":"131505885","full_name":"lizheming/animaris","owner":"lizheming","description":"Documentation and Mock for JSBridge base on ThinkJS \u0026 MongoDB \u0026 React \u0026 Antd.","archived":false,"fork":false,"pushed_at":"2021-06-08T07:13:15.000Z","size":991,"stargazers_count":29,"open_issues_count":0,"forks_count":3,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-08T21:41:39.900Z","etag":null,"topics":["antd","antd-design-pro","jsbridge","mock","mongodb","react","thinkjs","thinkjs3","webview"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/lizheming.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-04-29T15:24:51.000Z","updated_at":"2025-01-04T13:54:37.000Z","dependencies_parsed_at":"2022-08-14T08:40:54.356Z","dependency_job_id":null,"html_url":"https://github.com/lizheming/animaris","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/lizheming/animaris","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lizheming%2Fanimaris","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lizheming%2Fanimaris/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lizheming%2Fanimaris/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lizheming%2Fanimaris/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lizheming","download_url":"https://codeload.github.com/lizheming/animaris/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lizheming%2Fanimaris/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263409633,"owners_count":23462266,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["antd","antd-design-pro","jsbridge","mock","mongodb","react","thinkjs","thinkjs3","webview"],"created_at":"2024-10-11T19:26:56.520Z","updated_at":"2025-07-03T21:41:08.934Z","avatar_url":"https://github.com/lizheming.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n  \u003ca href=\"https://github.com/lizheming/animaris\"\u003e\n    \u003cimg width=\"315\" heigth=\"170\" src=\"https://s5.ssl.qhres2.com/static/4a0fac0dd5f0cae2.svg\"\u003e\n  \u003c/a\u003e  \n\n  \u003ch1\u003eAnimaris\u003c/h1\u003e\n\n  \u003cdiv\u003e\n    \u003ca href=\"https://github.com/lizheming/animaris\"\u003e\n      \u003cimg src=\"https://img.shields.io/badge/node-%3E%3D8.9.4-red.svg?style=flat-square\" alt=\"node version required\" /\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://github.com/lizheming/animaris/blob/master/LICENSE\"\u003e\n      \u003cimg src=\"https://img.shields.io/github/license/lizheming/animaris.svg?colorB=f48041\u0026style=flat-square\" alt=\"License\"\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://hub.docker.com/r/lizheming/animaris\"\u003e\n      \u003cimg src=\"https://img.shields.io/microbadger/image-size/lizheming/animaris.svg?style=flat-square\u0026logo=dockbit\" alt=\"MicroBadger Size\"\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://hub.docker.com/r/lizheming/animaris\"\u003e\n      \u003cimg src=\"https://img.shields.io/microbadger/layers/lizheming/animaris.svg?style=flat-square\u0026logo=dockbit\" alt=\"MicroBadger Layers\"\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://discord.gg/ZCD8yc5\"\u003e\n      \u003cimg src=\"https://img.shields.io/badge/chat-on%20discord-7289da.svg?style=flat-square\u0026logo=discord\" alt=\"Chat\"\u003e\n    \u003c/a\u003e\n  \u003c/div\u003e\n\n  \u003cp\u003eDocumentation and Mock for Mobile WebView APIs base on ThinkJS \u0026 MongoDB \u0026 React \u0026 Antd.\u003c/p\u003e\n\u003c/div\u003e\n\n[简体中文文档](https://github.com/lizheming/animaris/blob/master/README_zh-CN.md)\n\n## Introduction\n\nAnimaris is a system to resolve problem about mobile webview api documentation and mock. We use [ThinkJS](https://thinkjs.org) and MongoDB for server, React and [Antd](https://ant.design) for front end, [Docsify](http://docsify.js.org) for documentation at last. Animaris fixed follow questions:\n\n1. A visual documentation for Mobile WebView API.\n2. How mock Mobile WebView API.\n\nIf your Mobile web page depend on WebView API, you should inspect to simulator or physical machine. It's very terrible. All we know api mock program usually support server http api, there has little mock webview api program.\n\n## Installation\n\n### Docker Compose\n\nYou can easily run animaris using [docker-compose](https://docs.docker.com/compose/). Project have an example config named `docker-compose.yml` for you. You can use it directly or config it.  It relies on a number of environment variables that you can set before running `docker-compose up`. The variables are described below.\n\n```yaml\nversion: '2'\n\nservices: \n  animaris:\n    image: lizheming/animaris:latest\n    ports: \n      - 8360:8360\n    restart: always\n    environment:\n      # mongo database setting\n      - MONGO_HOST=mongo\n      - MONGO_PORT=27017\n      - MONGO_DATABASE=animaris\n      # If your mongo setting have user auth you should add below enviroment\n      # - MONGO_USER=admin\n      # - MONGO_PASSWORD=admin\n\n  mongo:\n    image: mongo\n    environment:\n      # mongo data path\n      - MONGO_DATA_DIR=/data/db\n    volumes: \n      - ./runtime/data:/data/db\n    command: mongod --smallfiles\n```\n\nAfter run `docker-compose -f docker-composer.yml up`, you can open `http://localhost:8360` to view program.\n\n### Normal Install\n\nIf you don't use docker, you also can install it with common method. First of all you should have Node.js v8+, and then clone repo:\n\n```\ngit clone git@github.com:lizheming/animaris.git\n```\n\nModify `src/config/adapter.js` with your mongo config and then install dependencies.\n\n```\nvim +48 src/config/adapter.js\nnpm install\n```\n\nThen compile js and start server.\n\n```\nnpm run webpack\nnpm start\n```\n\nAfter start, you can open `http://localhost:8360` to view program.\n\n## Documentation\n\nAfter start, you can see RESTful APIs documentation at \u003chttp://localhost:8360/doc/\u003e.\n\n## Name\n\nAnimaris means machines like humans, that's function same as Mock.\n\n## Screenshot\n\nDocumentation List\n\n![](https://p0.ssl.qhimg.com/t0194fc9409ff5770e2.jpg)\n\nDocumentation view page\n\n![](https://p0.ssl.qhimg.com/t01e4a2090ed1f5aed5.jpg)\n\nMock data setting page\n\n![](https://p0.ssl.qhimg.com/t015a770a88a74fa694.jpg)\n\n## License \n\n[MIT](https://github.com/lizheming/animaris/blob/master/LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flizheming%2Fanimaris","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flizheming%2Fanimaris","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flizheming%2Fanimaris/lists"}