https://github.com/randikabanura/windstarter
https://github.com/randikabanura/windstarter
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/randikabanura/windstarter
- Owner: randikabanura
- License: mit
- Created: 2022-02-26T13:46:01.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2022-02-26T15:22:09.000Z (over 3 years ago)
- Last Synced: 2025-02-05T02:39:36.101Z (4 months ago)
- Language: HTML
- Size: 19.5 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Windstarter Rails Template
All your Rails apps should start off with a bunch of great defaults. It's like Laravel Spark, for Rails.
## Getting Started
Windstarter is a Rails template, so you pass it in as an option when creating a new app.
#### Requirements
You'll need the following installed to run the template successfully:
* Ruby 2.5 or higher
* bundler - `gem install bundler`
* rails - `gem install rails`
* Database - we recommend Postgres, but you can use MySQL, SQLite3, etc
* Redis - For ActionCable support
* ImageMagick or libvips for ActiveStorage variants
* Yarn - `brew install yarn` or [Install Yarn](https://yarnpkg.com/en/docs/install)
* Foreman (optional) - `gem install foreman` - helps run all your processes in development
#### Creating a new app
```bash
rails new myapp -d postgresql -m https://raw.githubusercontent.com/randikabanura/windstarter/master/template.rb
```
Or if you have downloaded this repo, you can reference template.rb locally:
```bash
rails new myapp -d postgresql -m template.rb
```
❓Having trouble? Try adding `DISABLE_SPRING=1` before `rails new`. Spring will get confused if you create an app with the same name twice.
#### Running your app
```bash
bin/dev
```
You can also run them in separate terminals manually if you prefer.
A separate `Procfile` is generated for deploying to production on Heroku.
#### Enabling Admin Panel
App uses `madmin` [gem](https://github.com/excid3/madmin), so you need to run the madmin generator:
```
rails g madmin:install
```
This will install Madmin and generate resources for each of the models it finds.
#### Redis set up
##### On OSX
```
brew update
brew install redis
brew services start redis
```
##### Ubuntu
```
sudo apt-get install redis-server
```
#### Cleaning up
```bash
rails db:drop
spring stop
cd ..
rm -rf myapp
```