README

This is a rails copy of ss-panel. Theme by SB Admin 2 Theme

ScreenShots

Requirements

• ruby 2.2+
• rails 4.2+
• mysql
• redis

Install

1. clone repository

$ git clone [email protected]:timlentse/ss-panel-rails.git

2. install gems

$ cd ss-panel-rails
$ bundle install --path=vendor/bundle

3. load database and tables

we use mysql as database for rails. Import sql file in connfig/db_init.sql to mysql

mysql> source `absolute path of db_init.sql `;

4. create database.yml

For security consideration, the database.yml was not put in version control, so we should create one.

$ vi config/database.yml

• paste the following

default: &default
  adapter: mysql2
  pool: 5
  timeout: 5000
  database: 'sspanel_db'
  host: 'localhost'

# In development environment
development:
  <<: *default
  username: "your mysql username"
  password: "your mysql password"

# In production environment
production:
  <<: *default
  username: "your mysql username"
  password: "your mysql password"

5. some configuration

• Notice: All private setting are stored in file config/settings.local.yml. Create a file settings.local.yml in directory ss-panel-rails/config and add the following for smtp setting

mailer: :mailgun # set to :smtp if you don't use mailgun
email_sender: "[email protected]" # default send from
# mailgun setting
mailgun_api_key: "you mailgun api key"
mailgun_domain: "you mailgun domain"
mailgun_password: "mailgun smtp setting password"
mailgun_user_name: "username of mailgun smtp"

• regeister a mailgun account here if you use mailgun to send email

Time to playaround

Go to app root directory and type:

$ rails s

open browser and visit http://localhost:3000

Contribute

• fork the repository
• add new features and commit
• pull request

wiki

see how to integrate you rails using nginx and puma wiki

LICENSE

MIT