{"id":15993777,"url":"https://github.com/azuobs/windfury","last_synced_at":"2025-07-13T18:39:59.905Z","repository":{"id":143238974,"uuid":"74603208","full_name":"AzuObs/windfury","owner":"AzuObs","description":":leaves: Shamanize your next static website with the most powerful React-based technologies.","archived":false,"fork":false,"pushed_at":"2016-11-15T15:50:43.000Z","size":386,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-06-11T10:57:33.487Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/AzuObs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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-11-23T18:23:18.000Z","updated_at":"2017-07-28T18:32:16.000Z","dependencies_parsed_at":"2023-05-25T22:15:38.940Z","dependency_job_id":null,"html_url":"https://github.com/AzuObs/windfury","commit_stats":{"total_commits":84,"total_committers":2,"mean_commits":42.0,"dds":"0.13095238095238093","last_synced_commit":"3aa4c883ee1f21a54abeeb3a9536ee0cf644058e"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/AzuObs/windfury","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AzuObs%2Fwindfury","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AzuObs%2Fwindfury/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AzuObs%2Fwindfury/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AzuObs%2Fwindfury/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AzuObs","download_url":"https://codeload.github.com/AzuObs/windfury/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AzuObs%2Fwindfury/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265188976,"owners_count":23725188,"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-10-08T07:02:24.029Z","updated_at":"2025-07-13T18:39:59.853Z","avatar_url":"https://github.com/AzuObs.png","language":"JavaScript","readme":"![Windfury Logo](https://static.mapleinside.com/windfury/windfury-logo.jpg)\n\n# Windfury\n\n[![CircleCI](https://circleci.com/gh/mapleinside/windfury.svg?style=svg)](https://circleci.com/gh/mapleinside/windfury)\n\n\u003e Shamanize your next static website with the most powerful React-based technologies.\n\nWindfury is a full-featured and opinionated tooling library. It's mainly focused on improving developer experience (DX) on [React](https://facebook.github.io/react/)-based technologies. No more JavaScript fatigue. Just focus to build your website, don't worry about your tooling stack!\n\n## Philosophy\n\n* Single-dependency: [...]\n* Opinionated: [...]\n* Deployment pipeline support: [...]\n\n## Features\n\n* React stack based: [...]\n* Live-reload and hot reloading: [...]\n* CSS modules: [...]\n* Deployment: [...]\n\n## Quick Start\n\nLet's start by create a new Node.js project. Windfury works great with the following boilerplate: [mapleinside/website-boilerplate](https://github.com/mapleinside/website-boilerplate).\n\nHowever, if you want to start from scratch, Windfury is opinionated by nature, so you should follow Maple Inside's architecture conventions in order to use it.\nWhen you're ready to go, install Windfury as local dependency:\n\n```bash\nnpm i windfury --save-dev\n```\n\nWrite the configuration's file _windfury.yml_ (see [Customization](#customization) for more information).\nAnd finally, start the development server:\n\n```bash\nwindfury start\n```\n\n`./src` is the main source directory. Start write code here!\n\n## Commands\n\nFor best use, commands should be defined into the [package.json](https://docs.npmjs.com/files/package.json) as NPM scripts.\n\n* `windfury start`: spin up a development server with live-reload and [HMR](http://webpack.github.io/docs/hot-module-replacement.html);\n* `windfury build`: build a production-ready version of the website;\n* `windfury deploy`: deploy your website sources to the specified [AWS S3](http://docs.aws.amazon.com/AmazonS3/latest/dev/Welcome.html) bucket.\n\n### Commands arguments\n\n* `-e` or `--env-file`: use another _.env_ file instead of _./env/dev.env_. Useful to build a production-ready version of the app for the staging or production environment (e.q. `--env-file=./env/staging.env`).\n\n### How Windfury Works\n\n[...]\n\n## Customization\n\nWindfury uses a YAML file named _windfury.yml_ as configuration. You can easily custom many options here.\nBelow these are the mandatory options:\n\n```yaml\naws:\n  region: us-west-2\n  s3:\n    bucket: mywindfurywebsite.com\nenv:\n  secret:\n    - NPM_TOKEN\n```\n\n### Options\n\nHere the full customizable options for Windfury:\n\n```yaml\naws:\n  region: us-west-2\n  s3:\n    bucket: mywindfurywebsite.com\nenv:\n  secret:\n    - NPM_TOKEN\n```\n\n## License\n\nWindfury is [MIT licensed](./LICENSE).\n\nWindfury documentation is [Creative Commons licensed](./LICENSE-docs).\n\nExamples provided in this repository and in the documentation are [separately licensed](./LICENSE-examples).\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fazuobs%2Fwindfury","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fazuobs%2Fwindfury","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fazuobs%2Fwindfury/lists"}