Skip to content

Latest commit

 

History

History
84 lines (57 loc) · 3.57 KB

README.md

File metadata and controls

84 lines (57 loc) · 3.57 KB
Raw

Adminlte Rails Template

This is just a simple Rails template application of an admin panel with the AdminLTE (v.2.3.7) theme integrated to use as a starting point for your application.

Main features included by default:

  • Devise with default modules.
  • AdminLTE (v.2.3.7) theme included for the admin panel.
  • SendGrid gem for mailing.
  • Continuous testing with Guard.
  • Puma server.
  • PostgreSQL database.
  • ERB template engine.

There is an user example ready to use to login with email [email protected] and password 123456789.

Home Page Home page.

Login Page Login page.

Dashboard Page Dashboard page.

Original author

Iván González, a.k.a dreamingechoes

Regular development environment setup

To start using this template, you only have to do the typical Rails things:

  • Install Ruby version 2.4.0 (using RVM or RBenv or asdf or whatever).

  • Clone the repo and do the bundle install thing:

user@computer:~$ git clone [email protected]:dreamingechoes/adminlte-rails-template.git YOUR_APP_NAME_HERE
user@computer:~$ cd YOUR_APP_NAME_HERE
user@computer:/YOUR_APP_NAME_HERE$ bundle install

Duplicate all the .example files on the project (config/database.yml.example, config/secrets.yml.example, .env.example...) removing the .example extension, and complete them with the proper information. Then execute this to create the database:

user@computer:/YOUR_APP_NAME_HERE$ rake db:setup
user@computer:/YOUR_APP_NAME_HERE$ rake db:seed

And you're ready to go. Test if all it's ok by starting a server and check it with rails s. To enable any AdminLTE plugin, just simply open the assets/javascripts/application_back.js and assets/stylesheets/application_back.scss manifest files to require the needed asset files.

You can see the complete documentation of the AdminLTE theme here in order to add all the widgets that you need for your application.

Setup development environment with Docker

This project is Docker friendly, so if you want to use Docker with this template, just execute:

  • Setup the web container with docker-compose build web
  • Create database with docker-compose run web rake db:create
  • Execute migrations with docker-compose run web rake db:migrate
  • Start the application with docker-compose up

If you want to create an example user with the proper service, just execute:

user@computer:/YOUR_APP_NAME_HERE$ docker-compose exec web rails c

and on the Rails console execute:

[1] pry(main)> CreateAdminService.new.call

This project was developed by dreamingechoes. It adheres to its code of conduct and contributing guidelines, and uses an equivalent license.