{"id":18940349,"url":"https://github.com/donejs/bitcentive","last_synced_at":"2025-04-15T19:31:14.319Z","repository":{"id":136943567,"uuid":"62910606","full_name":"donejs/bitcentive","owner":"donejs","description":null,"archived":false,"fork":false,"pushed_at":"2020-04-29T23:03:06.000Z","size":8383,"stargazers_count":7,"open_issues_count":47,"forks_count":3,"subscribers_count":19,"default_branch":"staging","last_synced_at":"2025-03-29T01:41:28.399Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://bitcentive.herokuapp.com/","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/donejs.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-07-08T18:54:59.000Z","updated_at":"2020-04-06T17:57:56.000Z","dependencies_parsed_at":null,"dependency_job_id":"93bf74c6-b972-4769-8acc-ba36ef21f06d","html_url":"https://github.com/donejs/bitcentive","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/donejs%2Fbitcentive","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/donejs%2Fbitcentive/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/donejs%2Fbitcentive/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/donejs%2Fbitcentive/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/donejs","download_url":"https://codeload.github.com/donejs/bitcentive/tar.gz/refs/heads/staging","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249138716,"owners_count":21218930,"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-08T12:22:14.832Z","updated_at":"2025-04-15T19:31:14.312Z","avatar_url":"https://github.com/donejs.png","language":"JavaScript","readme":"# bitcentive\n\n\u003e Royalties\n\n[![Build Status](https://travis-ci.org/donejs/bitcentive.svg?branch=staging)](https://travis-ci.org/donejs/bitcentive)\n\n## About\n\nBitcentive uses [DoneJS](http://donejs.com) and  [Feathers](http://feathersjs.com), two open source web frameworks for building modern real-time applications.\n\n## Getting Started\n\nGetting up and running is as easy as 1, 2, 3.\n\n1. Make sure you have [NodeJS](https://nodejs.org/), [npm](https://www.npmjs.com/) and [MongoDb](https://www.mongodb.com/) installed.\n\n#### Installing MongoDB on OSX\n\nOn a Mac, the easiest way to install and configure [MongoDB](https://www.mongodb.com/)\nis using the [brew](https://brew.sh/) utility:\n\n```\nbrew install mongodb\n```\n\nPay special attention to the end of the [brew](https://brew.sh/) command's\noutput, which includes instructions on how to start `mongodb`:\n\nTo have launchd start mongodb now and restart at login:\n  ```brew services start mongodb```\nOr, if you don't want/need a background service you can just run:\n  ```mongod --config /usr/local/etc/mongod.conf```\n\nWe recommend the `brew services` option. If desired, `mongodb` can be\nstopped and uninstalled by running:\n\n```\nbrew uninstall mongodb\n```\n\n\n2. Install your dependencies\n\n    ```\n    cd path/to/bitcentive; npm install\n    ```     \n\n3. Start your app\n\n    ```\n    npm run develop\n    ```\n\n## Migrations\n\nPlease read the [migration docs](./migrations/README.md).\n\n## Testing\n\nSimply run `npm test` and all your tests in the `test/` directory will be run.\n\n## Scaffolding\n\nFeathers has a powerful command line interface. Here are a few things it can do:\n\n```\n$ npm install -g feathers-cli             # Install Feathers CLI\n\n$ feathers generate service               # Generate a new Service\n$ feathers generate hook                  # Generate a new Hook\n$ feathers generate model                 # Generate a new Model\n$ feathers help                           # Show all commands\n```\n\n## Logging in with GitHub\n\nThe bitcentive demo app allows Authenticated login using [GitHubs OAuth api](https://developer.github.com/v3/oauth/).\n\nWhen you run your demo locally, there are some steps you are going to need to take, so that you can *log in* to the app using your github account.\n\n#### 1. Register your application on GitHub\nGo to the [GitHub application registration form](https://github.com/settings/applications/new) and fill out the form.\n\nYou can fill out every piece of information however you like, except the **Authorization callback URL**. This is easily the most important piece to setting up your application. It's the callback URL that GitHub returns the user to after successful authentication. Assuming you are using all the config from the repo unchanged, you should set this to `http://localhost:3030/auth/github/callback`.\n\n#### 2. Configure your Client ID and Client Secret\nAfter registering your application with GitHub, you will be provided a **Client ID** and a **Client Secret** token. **You will need to set these values in your configuration for your app to work properly**.\n\nOpen the json file at `/config/default.json` and find the `github.clientID` property and put your **Client ID** as the value there.\n\nThe **GitHub Client Secret** you want to be a little more careful with, and it should never be committed to the repo or published anywhere else.\n\nYou have two options for setting your **Client Secret**, you can:\n\n1. set an [Environment Variable](https://en.wikipedia.org/wiki/Environment_variable) called `GITHUB_CLIENT_SECRET` on your system with a value equal to your system\n2. You can add a `local.json` file to the `config` directory in the project, and put some content like this in there:\n\n```json\n{\n  \"auth\": {\n    \"github\": {\n      \"clientSecret\": \"REPLACE THIS WITH YOUR GITHUB_CLIENT_SECRET\"\n    }\n  }\n}\n```\nThis file is ignored by git (`.gitignore`), and will not be commited to the repo, but will be read by the app when running locally.\n\nWith one of these two options in place you should now be able to \"Login with Github\" in the app.\n\n\n## Secrets and Environment Variables\n\nWe **must not** commit our **secrets** to our repository, so to store our secrets we use either **Environment Variables** or a \"git ignored\" local config file at `config/local.json`.\n\nFor deployments or if you prefer for development you can just set the value of the **Environment Variables** `GITHUB_CLIENT_SECRET` and `FEATHERS_AUTH_SECRET` to the client secret provided by GitHub and your particular feathers secret respectively.\n\nAlternatively create a `local.json` file and stick it in the root `config` directory and any values here will override the corresponding values in the configuration as per [feathers-configuration](https://github.com/feathersjs/feathers-configuration).\n\n## Help\n\nFor more information on all the things you can do with Feathers visit [docs.feathersjs.com](http://docs.feathersjs.com).\n\n## Changelog\n\n__0.1.0__\n\n- Initial release\n\n## License\n\nCopyright (c) 2016\n\nLicensed under the [MIT license](LICENSE).\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdonejs%2Fbitcentive","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdonejs%2Fbitcentive","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdonejs%2Fbitcentive/lists"}