https://github.com/junjizhi/rails-material-theme
A base Rails app with Material theme
https://github.com/junjizhi/rails-material-theme
bootstrap-material rails rails-bootstrap rails-bootstrap-theme rails-materials rails-materials-theme
Last synced: 3 months ago
JSON representation
A base Rails app with Material theme
- Host: GitHub
- URL: https://github.com/junjizhi/rails-material-theme
- Owner: junjizhi
- Created: 2019-02-09T18:07:13.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-05-04T12:16:22.000Z (about 6 years ago)
- Last Synced: 2025-01-01T01:44:13.580Z (5 months ago)
- Topics: bootstrap-material, rails, rails-bootstrap, rails-bootstrap-theme, rails-materials, rails-materials-theme
- Language: Ruby
- Homepage: https://github.com/junjizhi/rails-material-theme
- Size: 42 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# README
This project provides a base Rails app with [Material Theme](https://daemonite.github.io/material/) theme. The app also comes with basic
functionalities like User Sign-up and Log-in.
With a few steps, you can customize the app for your own needs.
## Screenshots
## Dependencies
Below is the environment I tested on:
```
$ ruby -v
ruby 2.5.0p0 (2017-12-25 revision 61468) [x86_64-darwin17]
$ rails --version
Rails 5.2.3
```
By default, the app depends on postgres v9.6.
## Database creation & initialization
```
bundle exec rake db:create
bundle exec rake db:migrate
```
Note: The user model is created with the
[Devise](https://github.com/plataformatec/devise) gem.
## Running the app locally
```
export DATABASE_URL=postgres://:@localhost:5432/rails-material-dev
export RAILS_ENV=development
bundle exec rails s
```
Visit the page: http://localhost:3000/
## Gems already installed
- Bootstrap
- Devise
- jquery
- material-sass
- bootstrap_form
## Customize the app
- Rename the app (search and replace `hotpot` with your app's name)
- Tweak the front end for you needs
## Contributing
To contribute, follow the steps:
- Fork this repo and clone to your local machine
- Create your feature branch (`git checkout -b my-awesome-feature`)
- Commit your changes (`git commit -am 'Implement blah'`)
- Push to your branch (`git push origin my-awesome-feature`)
- Create a new pull pequest (PR) with a brief description of what and why.
- Get notified when your PR is merged!
Issues and pull requests are always welcome!