8000 Improve setup instructions by tagliala · Pull Request #8545 · activeadmin/activeadmin · GitHub
[go: up one dir, main page]

Skip to content

Improve setup instructions #8545

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

Conversation

tagliala
Copy link
Contributor
  • Separates database setup from server startup and clarifies asset handling.
  • Copy cssbundling-rails instructions from Upgrading guide as a recommended approach for managing Tailwind CSS assets
  • Suggest to start the server with bin/dev to handle both web and CSS building processes.

Ref: #8538

[ci skip]

@tagliala tagliala force-pushed the chore/fix-installation-guide branch 4 times, most recently from 024db0e to 8b381a9 Compare November 17, 2024 10:22
- Separate database setup from server startup and clarifies asset
  handling process
- Copy `cssbundling-rails` instructions from the Upgrading guide as a
  recommended approach for managing Tailwind CSS assets
- Suggest starting the server with `bin/dev` to handle both web and CSS
  building process

Ref: #8538

[ci skip]
@tagliala tagliala force-pushed the chore/fix-installation-guide branch from 8b381a9 to ae6eeba Compare November 17, 2024 10:22
rails importmap:install

bundle add cssbundling-rails
rails css:install:tailwind
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's not necessary to install tailwind. One can run command rails css:install and it should work.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I mean, gem 'tailwindcss-rails' may not be installed


```sh
bundle add importmap-rails
rails importmap:install
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As far as I know from my upgrade experience - it's also not necessary.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

rails importmap:install is not necessary because it is being performed by rails g active_admin:install


```sh
bin/dev
```
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think for those who doesn't have Procfile.dev you should give another option:

yarn build:css 
rails s

@andrewroth
Copy link

Hi,

I'm starting a new rails 8 app with active admin, and the styles didn't load at all, after following the basic guide.

After some searching I came across this, and followed the commands, but I get 02:15:57 css.1 | Specified input file ./app/assets/stylesheets/active_admin.css does not exist. -- any ideas?

Should I just go back to rails 7 for now and accept rails 8 and active admin are incompatible (is this actually the case)? Thanks.

@tagliala
Copy link
Contributor Author
tagliala commented Nov 26, 2024

Should I just go back to rails 7 for now and accept rails 8 and active admin are incompatible (is this actually the case)?

They are compatible:

#8538 (reply in thread)

If you have some sort of edge cases, or different instructions, please provide more information so we can improve the installation guide


edit: guide updated and tested again, I confirm that Rails 8.0 and Active Admin 4 beta are compatible

image

@andrewroth
Copy link

I still have no css after hours of effort.

If I run npx tailwindcss -i ./app/assets/stylesheets/active_admin.css -o ./app/assets/builds/active_admin.css --minify -c tailwind-active_admin.config.js manually, I get:

Rebuilding...
Error: Cannot find module 'tailwindcss/plugin'
Require stack:
...
 {
  code: 'MODULE_NOT_FOUND',
  requireStack: [
    '/Users/andrew/Development/node_modules/@activeadmin/activeadmin/plugin.js'
  ]
}

I've googled "Error: Cannot find module 'tailwindcss/plugin'" and tried every possible fix I can find with no success.

@andrewroth
Copy link

Is it possible to use active admin without tailwind?

@tagliala
Copy link
Contributor Author
tagliala commented Nov 26, 2024

Can you please provide the list of commands that you are executing?

Also please include Ruby and Node versions

ruby --version
# ruby 3.3.6 (2024-11-05 revision 75015d4c1f) [x86_64-darwin24]

node --version
# v20.18.1

rails _8.0.0_ new my_app
cd my_app
bundle add activeadmin -v=4.0.0beta14
bundle add devise
rails g active_admin:install
bundle add cssbundling-rails
rails css:install:tailwind
rails db:migrate
rails db:seed
yarn add @activeadmin/activeadmin@4.0.0-beta14
npm pkg set scripts.build:css="tailwindcss -i ./app/assets/stylesheets/active_admin.css -o ./app/assets/builds/active_admin.css --minify -c tailwind-active_admin.config.js"

Is it possible to use active admin without tailwind?

Can't tell, maybe there are infos here: #8223

@andrewroth
Copy link
8000

I am on an old node and osx, maybe that has something to do with it?

node --version
v16.16.0

ruby --version
ruby 3.3.6 (2024-11-05 revision 75015d4c1f) [x86_64-darwin17]

@tagliala
Copy link
Contributor Author

node --version
v16.16.0

This may be an issue, but we are not aware of such issue.

I remember that I couldn't update to v4 with Node 16, but I need to check why

@tagliala
Copy link
Contributor Author

I'm successfully running the application with node 16.20.2

@andrewroth
Copy link

That did get further, staring from a new app from scratch.

Now I get this:

image

@tagliala
Copy link
Contributor Author
8000 tagliala commented Nov 27, 2024

looks like assets are not being build

Can you try ./bin/dev instead of rails s and report any error in the asset building?

@renatoaug
Copy link

That did get further, staring from a new app from scratch.

Now I get this:

image

I am with this same problem here.

I ran using ./bin/dev and the result was:

image

@tagliala
Copy link
Contributor Author
tagliala commented Jan 9, 2025

Hi,

These are the instructions to create an app from scratch

SuperAdmin::CompaniesController looks like existing code

@renatoaug
Copy link

Hi,

These are the instructions to create an app from scratch

SuperAdmin::CompaniesController looks like existing code

Hi @tagliala ,

I was talking about the broken layout:

image

I followed all the steps here https://github.com/activeadmin/activeadmin/blob/master/UPGRADING.md to upgrade from v3 to v4 but I think the css is not being applied.

@teaforthecat
Copy link

Hi, just want to point out that this is a reasonable alternative to cssbundler if the goals are these:

  • ActiveAdmin 3
  • Rails 8 (with or without tailwind)
  • Not requiring node
bundle add dartsass-rails
echo "Rails.application.config.dartsass.builds = {\n  'active_admin.scss' => 'active_admin.css'\n}" > config/initializers/dartsass.rb
echo "sass: bin/rails dartsass:watch" >> Procfile.dev
bin/dev

I wonder if this could go into the activeadmin:install task just for the time between Rails 8 being out and ActiveAdmin 4 not yet out?

@tagliala tagliala mentioned this pull request Jan 29, 2025
1 task
it works effectively.

If you haven't installed and configured `cssbundling-rails` and
`importmap-rails`, please run:
Copy link
@thisismydesign thisismydesign Apr 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes this is necessary, but their setup might change. It's easiest to just say install and configure cssbundling-rails and importmap-rails

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants
0