{"id":19724783,"url":"https://github.com/bigchaindb/site","last_synced_at":"2025-04-29T23:30:33.386Z","repository":{"id":47036150,"uuid":"48292432","full_name":"bigchaindb/site","owner":"bigchaindb","description":"🦁 The fabulous cat of blockchain websites","archived":false,"fork":false,"pushed_at":"2023-07-19T12:23:39.000Z","size":51162,"stargazers_count":7,"open_issues_count":2,"forks_count":9,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-04-05T20:05:47.722Z","etag":null,"topics":["bigchaindb","cats","gulp","jekyll","marketing","unicorns","website"],"latest_commit_sha":null,"homepage":"https://www.bigchaindb.com","language":"CSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bigchaindb.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","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":"2015-12-19T18:15:53.000Z","updated_at":"2024-05-19T12:21:38.000Z","dependencies_parsed_at":"2024-11-11T23:28:50.260Z","dependency_job_id":"2f661dd7-fbc5-4c49-8946-07a417ebf0e0","html_url":"https://github.com/bigchaindb/site","commit_stats":null,"previous_names":[],"tags_count":20,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bigchaindb%2Fsite","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bigchaindb%2Fsite/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bigchaindb%2Fsite/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bigchaindb%2Fsite/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bigchaindb","download_url":"https://codeload.github.com/bigchaindb/site/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251599661,"owners_count":21615563,"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":["bigchaindb","cats","gulp","jekyll","marketing","unicorns","website"],"created_at":"2024-11-11T23:27:05.373Z","updated_at":"2025-04-29T23:30:28.372Z","avatar_url":"https://github.com/bigchaindb.png","language":"CSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"# [![site](media/repo-banner@2x.png)](https://www.bigchaindb.com)\n\n\u003e 🦁 The fabulous cat of blockchain websites.\n\n[![Build Status](https://travis-ci.com/bigchaindb/site.svg?branch=master)](https://travis-ci.com/bigchaindb/site)\n[![css bigchaindb](https://img.shields.io/badge/css-bigchaindb-39BA91.svg)](https://github.com/bigchaindb/stylelint-config-bigchaindb)\n[![js ascribe](https://img.shields.io/badge/js-ascribe-39BA91.svg)](https://github.com/ascribe/javascript)\n[![Greenkeeper badge](https://badges.greenkeeper.io/bigchaindb/site.svg)](https://greenkeeper.io/)\n\u003cimg src=\"http://forthebadge.com/images/badges/powered-by-electricity.svg\" height=\"20\"/\u003e\n\u003cimg src=\"http://forthebadge.com/images/badges/as-seen-on-tv.svg\" height=\"20\"/\u003e\n\u003cimg src=\"http://forthebadge.com/images/badges/uses-badges.svg\" height=\"20\"/\u003e\n\n---\n\n[Live](https://www.bigchaindb.com) | [Styleguide](https://www.bigchaindb.com/styleguide/) | [Beta](http://beta.bigchaindb.com) | [Gamma](http://gamma.bigchaindb.com)\n\n---\n\n* [Documentation](#documentation)\n* [Development](#development)\n    * [Prerequisites](#prerequisites)\n    * [Get up and running](#get-up-and-running)\n* [Continuous deployment: always be shipping](#continuous-deployment-always-be-shipping)\n* [Manual deployment](#manual-deployment)\n    * [Prerequisite: authentication](#prerequisite-authentication)\n    * [Staging build \u0026amp; beta deployment](#staging-build--beta-deployment)\n    * [Production build \u0026amp; live deployment](#production-build--live-deployment)\n* [Coding conventions](#coding-conventions)\n    * [(S)CSS](#scss)\n    * [JavaScript](#javascript)\n* [Authors](#authors)\n* [License](#license)\n\n## Documentation\n\nHave a look at the [`docs/`](docs/) folder.\n\n## Development\n\nThe whole website is a Jekyll site with a Gulp-based build pipeline in front of it.\n\n### Prerequisites\n\nYou need to have the following tools installed on your development machine before moving on:\n\n- [Node.js](http://nodejs.org/) \u0026 [npm](https://npmjs.org/)\n- [Ruby](https://www.ruby-lang.org) (for sanity, install with [rvm](https://rvm.io/))\n- [Bundler](http://bundler.io/)\n\n### Get up and running\n\nRun the following command from the repository's root folder to clone this repository, install all dependencies, and spin up local dev server reachable under [http://localhost:1337](http://localhost:1337):\n\n```bash\ngit clone git@github.com:bigchaindb/site.git\ncd site/\nnpm i \u0026\u0026 bundle install\n\n# development build and dev server\ngulp\n```\n\nAdditionally, you can execute those commands to test the actual build output:\n\n```bash\n# full production build\ngulp build --production\n\n# build preventing search engine indexing \u0026 Google Analytics tracking\ngulp build --staging\n```\n\nAll builds are output into the `_dist/` folder. Use a tool like [serve](https://github.com/zeit/serve) to inspect a local build in your browser:\n\n```bash\nserve -s _dist\n```\n\n## Continuous deployment: always be shipping\n\n![shipping](https://cloud.githubusercontent.com/assets/90316/26559768/e21e9724-44b1-11e7-90cf-6ef6ebb06d09.gif)\n\nThe site gets built \u0026 deployed automatically via Travis. This is the preferred way of deployment, it makes sure the site is always deployed with fresh dependencies and only after a successful build.\n\nBuild \u0026 deployment happens under the following conditions on Travis:\n\n- every push builds the site\n- **live deployment**: every push to the master branch initiates a live deployment\n- **beta deployment**: every new pull request and every subsequent push to it initiates a beta deployment\n\n## Manual deployment\n\nFor emergency live deployments or beta \u0026 gamma deployments, the manual method can be used. The site is hosted in an S3 bucket and gets deployed via a gulp task.\n\n### Prerequisite: authentication\n\nTo deploy the site, you must authenticate yourself against the AWS API with your AWS credentials. Get your AWS access key and secret and add them to `~/.aws/credentials`:\n\n```\n[default]\naws_access_key_id = \u003cYOUR_ACCESS_KEY_ID\u003e\naws_secret_access_key = \u003cYOUR_SECRET_ACCESS_KEY\u003e\n```\n\nThis is all that is needed to authenticate with AWS if you've setup your credentials as the default profile.\n\nIf you've set them up as another profile, say `[bigchaindb]` you can grab those credentials by using the `AWS_PROFILE` variable like so:\n\n```bash\nAWS_PROFILE=bigchaindb gulp deploy --live\n```\n\nIn case that you get authentication errors or need an alternative way to authenticate with AWS, check out the [AWS documentation](http://docs.aws.amazon.com/AWSJavaScriptSDK/guide/node-configuring.html).\n\n### Staging build \u0026 beta deployment\n\nThe staging build is a full production build but prevents search engine indexing \u0026 Google Analytics tracking.\n\n```bash\n# make sure your local npm packages \u0026 gems are up to date\nnpm update \u0026\u0026 bundle update\n\n# make staging build in /_dist\ngulp build --staging\n\n# deploy contents of /_dist to beta\ngulp deploy --beta\n```\n\nThere's also a second beta deployment target called gamma under http://gamma.bigchaindb.com:\n\n```bash\n# build preventing search engine indexing \u0026 Google Analytics tracking\ngulp build --staging\n\n# deploy contents of /_dist to gamma\ngulp deploy --gamma\n```\n\n\n### Production build \u0026 live deployment\n\n```bash\n# make sure your local npm packages \u0026 gems are up to date\nnpm update \u0026\u0026 bundle update\n\n# make production build in /_dist\ngulp build --production\n\n# deploy contents of /_dist to live\ngulp deploy --live\n```\n\n## Coding conventions\n\n### (S)CSS\n\nFollows [stylelint-config-bigchaindb](https://github.com/bigchaindb/stylelint-config-bigchaindb) which itself extends [stylelint-config-standard](https://github.com/stylelint/stylelint-config-standard).\n\nLint with [stylelint](https://stylelint.io) in your editor or run:\n\n```bash\nnpm test\n```\n\n### JavaScript\n\nIt's a wild mess right now between old school vanilla js, jQuery and some ES2015 features. Don't bother with the old stuff unless dependency updates break it.\n\nNew js should follow [eslint-config-ascribe](https://github.com/ascribe/javascript). Linting in this repo is not setup for it yet.\n\n## Authors\n\n- Matthias Kretschmann ([@kremalicious](https://github.com/kremalicious)) - [BigchainDB](https://www.bigchaindb.com) \u0026 [Ocean Protocol](https://oceanprotocol.com)\n- [All the contributors](https://github.com/bigchaindb/site/graphs/contributors)\n\n## License\n\n```\nCopyright 2018 BigchainDB GmbH\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n   http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbigchaindb%2Fsite","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbigchaindb%2Fsite","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbigchaindb%2Fsite/lists"}