{"id":18336311,"url":"https://github.com/launchpadlab/fuel","last_synced_at":"2025-06-15T05:32:24.519Z","repository":{"id":15935452,"uuid":"18677525","full_name":"LaunchPadLab/fuel","owner":"LaunchPadLab","description":null,"archived":false,"fork":false,"pushed_at":"2023-06-01T13:59:10.000Z","size":8632,"stargazers_count":12,"open_issues_count":5,"forks_count":6,"subscribers_count":17,"default_branch":"master","last_synced_at":"2025-05-29T13:57:58.846Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Ruby","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/LaunchPadLab.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"MIT-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,"zenodo":null}},"created_at":"2014-04-11T14:47:52.000Z","updated_at":"2017-12-15T23:08:27.000Z","dependencies_parsed_at":"2025-06-15T05:32:05.917Z","dependency_job_id":null,"html_url":"https://github.com/LaunchPadLab/fuel","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/LaunchPadLab/fuel","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LaunchPadLab%2Ffuel","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LaunchPadLab%2Ffuel/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LaunchPadLab%2Ffuel/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LaunchPadLab%2Ffuel/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/LaunchPadLab","download_url":"https://codeload.github.com/LaunchPadLab/fuel/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LaunchPadLab%2Ffuel/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259926928,"owners_count":22933131,"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-05T20:07:26.461Z","updated_at":"2025-06-15T05:32:24.493Z","avatar_url":"https://github.com/LaunchPadLab.png","language":"Ruby","readme":"Fuel\n====================\n[![Code Climate](https://codeclimate.com/github/LaunchPadLab/fuel.png)](https://codeclimate.com/github/LaunchPadLab/fuel)\n[![Code Climate](https://codeclimate.com/github/LaunchPadLab/fuel/coverage.png)](https://codeclimate.com/github/LaunchPadLab/fuel)\n\nBy [LaunchPad Lab](http://launchpadlab.com).\n\nStop developing Rails blogs and start writing your actual blog posts with this dead simple blogging engine for Rails.\n\nOverview\n-------------------\n\nFuel is still in beta but is actively being used in several production environments. The schema is very simple and consists of Posts and Authors and is namespaced under Fuel to ensure it won't interfere with any of your current models.\n\nScreenshots are available here: http://learn.launchpadlab.com/fuel/\n\n\nInstallation\n--------------------\n\nGemfile:\n\n```ruby\ngem \"fuel\", :git =\u003e \"https://github.com/launchpadlab/fuel.git\", branch: \"master\"\n```\n\nTerminal:\n\n```\nbundle\nrails g fuel:install\n```\n\nSee below for instructions on how to get image uploading wired up as blogging is no fun without pictures.\n\n\nBasic Usage\n--------------------\n\n**Paths**\n\n* Path to Admin Panel: /blog/admin\n* Path to Blog: /blog\n\n**Admin Username / Password**\n\nThe default username and password is admin and password, respectively. You can change these in config/initializers/fuel.rb:\n\n```ruby\nconfig.username = \"admin\"\n\nconfig.password = \"password\"\n```\n\n**Views**\n\nIf you want to customize the views, you can generate them in terminal:\n\n```\nrails generate fuel:views\n```\n\n**Layout**\n\nYou will probably want the blog posts to render within an existing layout of your application. By default, it will render within \"application\" layout. You can change this in config/initializers/fuel.rb:\n\n```ruby\nconfig.layout = \"application\"\n```\n\n**Logo**\n\nYou can add your own logo to be used in the Blog Admin backoffice. Add your logo's image to your Rails app's images folder (app/assets/images) then update config/initializers/fuel.rb to reference that image like below. Note that the image should be square and at least 58 x 58 pixels.\n\n```ruby\nconfig.logo = \"your-image.png\"\n```\n\n\nImage Uploading\n--------------------\n\nFuel ships with Paperclip and S3 for uploading images for your blog posts and authors. To get these working, all you need to do is pass the right credentials to the below variables defined in config/initializers/fuel.rb:\n\n```ruby\n  # AWS S3 SETTINGS\n  config.aws_bucket = ENV['AWS_BUCKET']\n  config.aws_access_key = ENV[\"AWS_ACCESS_KEY\"]\n  config.aws_secret_access_key = ENV[\"AWS_SECRET_ACCESS_KEY\"]\n```\n\nWe recommend using [Figaro](https://github.com/laserlemon/figaro) to properly set these environment variables:\n\n```yml\n# config/application.yml\n\nAWS_ACCESS_KEY: your-s3-access-key\nAWS_SECRET_ACCESS_KEY: your-s3-secret-key\n\ndevelopment:\n  AWS_BUCKET: your-development-s3-bucket\nproduction:\n  AWS_BUCKET: your-production-s3-bucket\n```\n\n\nIn order for the uploads to work, you will need to change your CORS settings on each of your S3 buckets in Amazon S3's admin console (i.e. both your development and production and possibly staging if you have that environment as well). You can find the file in: your-bucket =\u003e Properties =\u003e Permissions =\u003e Edit CORS Configuration\n\n```\n\u003c?xml version=\"1.0\" encoding=\"UTF-8\"?\u003e\n\u003cCORSConfiguration xmlns=\"http://s3.amazonaws.com/doc/2006-03-01/\"\u003e\n  \u003cCORSRule\u003e\n    \u003cAllowedOrigin\u003ehttp://localhost:3000\u003c/AllowedOrigin\u003e\n    \u003cAllowedMethod\u003eGET\u003c/AllowedMethod\u003e\n    \u003cAllowedMethod\u003ePOST\u003c/AllowedMethod\u003e\n    \u003cAllowedMethod\u003ePUT\u003c/AllowedMethod\u003e\n    \u003cAllowedHeader\u003e*\u003c/AllowedHeader\u003e\n  \u003c/CORSRule\u003e\n\u003c/CORSConfiguration\u003e\n```\n\n\nSocial Integration\n--------------------\n\nTo set proper og:graph meta data for your blog, add the following to the head of your main layout (such as application.html.erb):\n\n```\n\u003c% if content_for?(:meta_tags) %\u003e\n  \u003c%= yield(:meta_tags) %\u003e\n\u003c% else %\u003e\n  \u003c!-- default meta tags here --\u003e\n\u003c% end %\u003e\n```\n\n**Twitter**\n\nSet config.twitter = true in initializer:\n\n```\n# config/initializers/fuel.rb\nconfig.twitter = true\n\n```\n\n\nSEO\n----------\n\nTo see our HTML `\u003ctitle\u003e` and `\u003cmeta\u003e description` for your blog, you have access to two instance variables: `@title` and `@description`. These should be called in your `layout` template for your blog as follows:\n\n```\n\u003ctitle\u003e\u003c%= @title %\u003e\u003c/title\u003e\n\u003cmeta name=\"description\" content=\"\u003c%= @description %\u003e\"\u003e\n```\n\nNote:\n\nFor your blog index page, `@title` and `@description` are defined in your Fuel configuration file.\n\nFor your blog post show page, `@title` and `@description` are defined by the values on your post for `seo_title` and `seo_description` respectively.\n\n\n**Facebook Share**\n\nNote: the purpose of this integration is for creating a custom share dialog link via the Javascript SDK. For more simplistic integrations, like the default Facebook Share button, please see this guide: https://developers.facebook.com/docs/plugins/share-button\n\n1. Create a Facebook application via developer.facebook.com and put your application ID in Fuel's initializer file (config/initializers/fuel.rb)\n2. Add a link in your view with class \"fuel-fb\" and data-url corresponding with the post:\n\n```\n\u003c%= link_to \"Facebook\", '#', class: \"fuel-fb\", data: { url: fuel.post_url(@post) } %\u003e\n```\n\nNote that until your application is deployed to a public domain, Facebook will not pull your og:graph meta information into the share dialog window.\n\n\nOther Customization Options\n--------------------\n\n\n**Disqus Commenting**\n\nIn config/initializers/fuel.rb, uncomment the following line and replace the name with your disqus account name:\n\n```\nconfig.disqus_name = 'your_disqus_name'\n```\n\n**Including Your Own Helpers**\n\nBy default, Fuel will only include your ApplicationHelper. You can tell Fuel to include additional helper files as well at config/initializers/fuel.rb:\n\n```ruby\nconfig.helpers = [\"ApplicationHelper\",\n                  #\"another_helper\",\n                  ]\n```\n\n\nContributing\n--------------------\n\nInterested in contributing to the Fuel project? Please contact ryan@launchpadlab.com for local setup instructions and proper ENV variables.\n\n\n\nThe MIT License (MIT)\n--------------------\n\nCopyright (c) 2015 LaunchPad Lab\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in\nall copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\nTHE SOFTWARE.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flaunchpadlab%2Ffuel","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flaunchpadlab%2Ffuel","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flaunchpadlab%2Ffuel/lists"}