zetavg/uapp-core

UAPP - Core

The core user authentication & management system.

Configuration

The two sample configuration files lays at config/configuration.yml.example and config/database.yml.example, just copy, remove the trailing .example and modify them to your liking.

If the .yml file dosen't exists, .yml.example will be used. So you can configure your app using only environment variables, especially when deploying to heroku or dokku.

Development Build

$ bundle install --without production
$ rake db:migrate
$ rails s  # or `ln -s "$(pwd)" ~/.pow/ntust` if you're using Pow

Generate API documentations:

$ rake swagger:docs

LiveReload

$ gem install guard guard-livereload
$ guard init livereload
$ bundle exec guard

Sample Guardfile:

notification :growl_notify

guard 'livereload' do
  watch(%r{app/views/.+\.(erb|haml|slim)$})
  watch(%r{app/helpers/.+\.rb})
  watch(%r{public/.+\.(css|js|html)})
  watch(%r{config/locales/.+\.yml})
  # Rails Assets Pipeline
  watch(%r{(app|vendor)(/assets/\w+/(.+\.(css|sass|scss|js|coffee|html|haml|png|jpg|svg))).*}) { |m| "/assets/#{m[3].gsub(/(s[ac]ss|coffee)$/, 'sass' => 'css', 'scss' => 'css', 'coffee' => 'js')}" }
end

Deploy & Setup

In order to let users experience using all sub-applications as a single system, this application should be deployed at the top-level domain (your.domain) while other sub-applications deployed at the subdomains (*.your.domain).

The web admin panel is located at http://[your.domain]/admin, default account: username admin with passowrd password.

• Change your administrator password.
• Add 學院 data to colleges table.
• Add 系所 data to departments table.
• Register yourself an account.
• Give admin power to some users by setting their admin attribute to true.
• Create some apps on http://[your.domain]/oauth/applications
  • Application owned by admin won't need permission granted by users when calling OAuth API, and can access advanced APIs, e.g. [admission_year]/[department_id]/[user_id].json

Contributing

1. Fork it.
2. Create your feature branch (git checkout -b my-new-feature).
3. Commit your changes (git commit -m 'add some feature').
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request.