{"id":19668194,"url":"https://github.com/dymio/mayak","last_synced_at":"2025-04-29T00:30:29.617Z","repository":{"id":16252971,"uuid":"19000896","full_name":"dymio/mayak","owner":"dymio","description":"Mayak - simple Rails application made for fast start of a common web-project","archived":false,"fork":false,"pushed_at":"2018-03-19T11:54:32.000Z","size":1594,"stargazers_count":11,"open_issues_count":0,"forks_count":2,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-05T11:41:23.669Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://mayak.io","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/dymio.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}},"created_at":"2014-04-21T17:44:25.000Z","updated_at":"2022-12-13T10:35:57.000Z","dependencies_parsed_at":"2022-09-24T11:41:59.811Z","dependency_job_id":null,"html_url":"https://github.com/dymio/mayak","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dymio%2Fmayak","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dymio%2Fmayak/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dymio%2Fmayak/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dymio%2Fmayak/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dymio","download_url":"https://codeload.github.com/dymio/mayak/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251410152,"owners_count":21584973,"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-11T16:34:45.853Z","updated_at":"2025-04-29T00:30:29.298Z","avatar_url":"https://github.com/dymio.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"Mayak Rails Website Template\n============================\n\nMayak - is simple Rails application made for fast start of a common web-project.\nI called it 'site template' because rails 'application templates'\n[already exist](http://guides.rubyonrails.org/rails_application_templates.html).\nWebsite template gives you major components of (almost) any website:\n\n* admin panel\n* settings\n* arbitrary files upload\n* pages managment\n* seo parameters system\n* navigation items\n* news\n* feedback form\n\n[Mayak.io](http://mayak.io/) — project's website.\n\n\nSoftware and coventions\n-----------------------\n\nTemplate based on Ruby 2.2.3 and use many brilliant ruby gems (check full list\nand versions in Gemfile):\n\n* [Ruby on Rails](http://rubyonrails.org/)\n* [ActiveAdmin](http://activeadmin.info/) for admin panel\n* [CarrierWave](https://github.com/carrierwaveuploader/carrierwave) for uploads\n* [Kaminari](https://github.com/amatsuda/kaminari) for pagination\n* [Autoprefixer](https://github.com/postcss/autoprefixer) for easy css\n* [Mina](http://nadarei.co/mina/) for deploy\n\nAlso we use:\n\n* [normalize.css](http://necolas.github.io/normalize.css/)\n* [Dymio's HTML CSS template](https://github.com/dymio/html-css-template)\n* [Chosen](http://harvesthq.github.io/chosen/)\n* [Trumbowyg WYSIWYG editor](https://github.com/Alex-D/Trumbowyg)\n\nAnd we respect [humans.txt](http://humanstxt.org/) convention.\n\n\nInstallation\n------------\n\n1. Get copy of code of this project (without git history).\n\n2. Make sure that you have Ruby version installed, specified\n    in `.ruby-version` file.\n\n3. If you're using RVM, add '.ruby-gemset' file to the root of the application.\n    [More info](https://rvm.io/workflow/projects#project-file-ruby-version).\n\n4. In the `config/application.rb` file:\n\n    * replace module name from 'Mayak' to your project name;\n\n    * set your timezone and default_locale;\n\n5. Replace all secret keys in file `config/secrets.rb`.\n    You can use `bin/rake secret` for keys generation\n    or [some web-generators](http://www.andrewscompanies.com/tools/wep.asp).\n    You can use `secret_key_base: \u003c%= ENV[\"SECRET_KEY_BASE\"] %\u003e` for production\n    if you need to hide production key from repo, but do not forget setup this\n    ENV variable on server.\n\n6. Create file `config/database.yml` for database connection.\n    There is `config/database_example.yml` for example.\n\n7. Create file `config/application.yml` for app configuration management with\n    Figaro gem. There is `config/application_example.yml` for example.\n\n8. Change `default-host` setting in the file `config/sitemap.rb`\n    (and do not forget about sitemap during development).\n\n9. Setting up the mailer in `config/environments/production.rb` file,\n    if you need to sending emails from site.\n\n10. In the file `config/initializers/active_admin.rb`\n    replace `config.site_title` with title of your site.\n\n11. In the file `config/initializers/devise.rb`\n    replace value of `config.mailer_sender`.\n\n12. In the file `config/initializers/session_store.rb` replace\n    session key `_mayak_session` with your project key.\n\n13. In the migration file of site settings\n    (`db/migrate/20170307000002_create_settings.rb`) you can change default\n    settings values and add new settings. TODO\n\n14. In the seeds file (`db/seeds.rb`) you can change email and password\n    of admin user. By default it admin@example.com with password 'password'.\n\n15. Check file `app/assets/browserslist` file and set\n    [settings](https://github.com/ai/browserslist#queries) you need\n    for Autoprefixer.\n\n16. Replace or remove LICENSE and UPDATE.md files.\n\n17. When done, run:\n\n    ```\n    $ bin/bundle install --without production\n    $ bin/rake db:create db:migrate\n    ```\n\nDemo data you can install with command: `bin/rake db:seed`\n\nElse you want to remove demo data you need to: TODO.\n\nDo not forget to change `public/favicon.ico` and all icons\nin directory `public/ico/`, fill `public/humans.txt` with correct data\nand uncomment correct lines in `public/robots.txt` before publishing.\n\nYour application ready for use.\nYou can launch webserver with command `bin/rails server` and see a home page\nat [http://localhost:3000](http://localhost:3000/) url.\n\nAnd, when you finish installation, replace content of this file with description\nabout your project and other usefull information.\nExample:\n\n    Your project name\n    =================\n\n    Short project description here.\n\n    Production url is [example.com](http://example.com/).\n\n    This is Ruby on Rails project,\n    based on [Mayak Rails website template](http://mayak.io/).\n\n\n    Getting Started\n    ---------------\n\n    Make sure you have Ruby version installed, specified in the `.ruby-version`\n    file in the root directory of the application.\n\n    If you use [RVM](https://rvm.io/) add a '.ruby-gemset'\n    [file](https://rvm.io/workflow/projects#project-file-ruby-version)\n    to the root directory of the application.\n\n    You will need [ImageMagick](https://www.imagemagick.org/) installed.\n\n    The application uses PostgreSQL. Versions 8.2 and up are supported.\n    Create database and config file `config/database.yml` for connection.\n    File example:\n\n        development:\n          adapter: postgresql\n          database: database_name\n          pool: 5\n\n    There is `config/database_example.yml` file for full example.\n\n    When done, run:\n\n        $ bin/bundle install --without production\n        $ bin/rake db:create db:migrate\n\n    Install demo data using command: `bin/rake db:seed` if you need.\n\n    Application ready for start. You can launch webserver with\n    command `bin/rails server` and see home page\n    at [localhost:3000](http://localhost:3000/) url.\n\n\n    Project life cycle\n    ------------------\n\n    ### Adding new routes\n\n    Put added route path to a config.fixed_pages_paths array\n    (in 'config/application.rb') if a Page object should cover this path.\n\n    Add the new route to the 'config/sitemap.xml' file.\n\n\n    Deploy\n    ------\n\n    Run deploy with command `mina deploy` or `mina production deploy`\n    for production instance.\n\n    Before the first deploy to server you'll need to run 'mina setup'\n    or `mina production setup` for production. Also you'll need create file\n    'application.yml' in 'shared/config' directory on the server.\n    Example of this file you can find in 'config' directory of the project.\n\n\nLicense\n-------\n\nMayak Rails Website Template is released under the [MIT License](LICENSE).\n\n\nContributing\n------------\n\n1. Fork it\n2. Create your feature branch (`git checkout -b my-new-feature`)\n3. Commit your changes (`git commit -am 'Add some feature'`)\n4. Push to the branch (`git push origin my-new-feature`)\n5. Create new Pull Request\n\nFeel free to use code of the project as you want,\n[create issues](https://github.com/dymio/mayak/issues) or make pull requests.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdymio%2Fmayak","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdymio%2Fmayak","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdymio%2Fmayak/lists"}