{"id":19164365,"url":"https://github.com/senchalabs/jsduck-comments","last_synced_at":"2025-10-28T14:39:04.911Z","repository":{"id":5307047,"uuid":"6488580","full_name":"senchalabs/jsduck-comments","owner":"senchalabs","description":"Comments server for JSDuck","archived":false,"fork":false,"pushed_at":"2013-08-16T09:05:15.000Z","size":323,"stargazers_count":8,"open_issues_count":4,"forks_count":3,"subscribers_count":14,"default_branch":"master","last_synced_at":"2025-04-19T22:01:38.197Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"redis/redis-rb","license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/senchalabs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"COPYING","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2012-11-01T11:29:23.000Z","updated_at":"2023-09-08T16:36:02.000Z","dependencies_parsed_at":"2022-09-14T21:21:26.885Z","dependency_job_id":null,"html_url":"https://github.com/senchalabs/jsduck-comments","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/senchalabs%2Fjsduck-comments","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/senchalabs%2Fjsduck-comments/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/senchalabs%2Fjsduck-comments/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/senchalabs%2Fjsduck-comments/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/senchalabs","download_url":"https://codeload.github.com/senchalabs/jsduck-comments/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252873937,"owners_count":21817708,"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":[],"created_at":"2024-11-09T09:21:37.599Z","updated_at":"2025-10-28T14:39:04.708Z","avatar_url":"https://github.com/senchalabs.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"JSDuck Comments Server\n======================\n\nNodeJS server for [JSDuck][] comments system on top of MySQL database.\n\n**NOTE:** The authentication system is currently targeted to work with\n[Sencha Forum][] users database.  If you're not from Sencha, then this\nis obviously not an option.  For that case there also exists an\nalternative implementation which uses a local users table, but as of\nnow the implementation doesn't cover registration, only the\nauthentication part.\n\n[JSDuck]: https://github.com/senchalabs/jsduck\n[Sencha Forum]: http://www.sencha.com/forum/\n\n\nInstall\n-------\n\nClone the repository and install dependencies:\n\n    $ git clone git://github.com/senchalabs/jsduck-comments.git\n    $ cd jsduck-comments\n    $ npm install\n\nCreate new MySQL database and run the schema.sql script to set up the\ntables:\n\n    $ mysql my_comments_db_name \u003c sql/schema.sql\n\nCreate config file with user \u0026 pass for connecting to MySQL database:\n\n    $ cp config.example.js config.js\n    $ vi config.js\n\n\nUsage\n-----\n\nRun the `app.js` script to start the server:\n\n    $ node app.js\n\nPreferably though, use [forever][] (or something similar) to run it,\nso in case it happens to crash it'll be restarted automatically:\n\n    $ forever -e errors.log --watch app.js\n\n[forever]: https://github.com/nodejitsu/forever\n\nNow the server is running, but we also need a client side, which of\ncourse is the docs app that JSDuck generates.  But we need to tell\nJSDuck the address of the server and the \"domain\" of comments.\n\nWhen you're running on your local machine, the URL will be\n`http://localhost:3000/auth` (unless you have changed the default port\nin config.js file).\n\nThe domain is a simple string of `\u003cname\u003e/\u003cversion\u003e` - it allows a\nsingle comments server to handle requests from multiple docs apps.  So\nyou could have multiple docs generated with the same comments server\nURL but with different domain names.\n\nFor example:\n\n    $ jsduck --comments-url http://localhost:3000/auth --comments-domain extjs/4 ...\n\nNow open the generated docs app in browser and try to log in with your\nusername and password.\n\n\nDevelopment\n-----------\n\nInstall [jasmine][] if you don't have it already:\n\n    $ npm install jasmine-node -g\n\n[jasmine]: https://github.com/mhevery/jasmine-node\n\nMake sure you have the `testDb` configured in `config.js` - just set\nup an empty MySQL database that'll be used for testing.  Then simply\nrun make:\n\n    $ make\n\nFor now the testsuite is database-io-heavy and therefore somewhat\nslow.  Hope to improve that on the future.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsenchalabs%2Fjsduck-comments","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsenchalabs%2Fjsduck-comments","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsenchalabs%2Fjsduck-comments/lists"}