About ruby-rails-boilerplate

rails restapi system platform is the beginning of the project https://meta.discourse.org/ https://github.com/captainoggy/chat-app

m

Published by

maearon

Visit View Profile

README.md

View on GitHub

Rails REST API + NextJS boilerplate 🇻🇳

📋 PostgreSQL – Xem các cột trong bảng 🔎 1. Cột trong bảng products

SELECT column_name, data_type
FROM information_schema.columns
WHERE table_name = 'products';

🧾 Tổng kết bảng products hiện có:

#   Column Name Data Type
1   id  bigint
2   created_at  timestamp
3   updated_at  timestamp
4   gender  varchar
5   franchise   varchar
6   producttype varchar
7   brand   varchar
8   category    varchar
9   sport   varchar
10  description_h5  text
11  description_p   text
12  specifications  text
13  care    text
14  name    varchar
15  jan_code    varchar

🔎 2. Cột trong bảng variants

SELECT column_name, data_type
FROM information_schema.columns
WHERE table_name = 'variants';

🧾 Tổng kết bảng variants hiện có:

#   Column Name Data Type
1   id  bigint
2   created_at  timestamp
3   updated_at  timestamp
4   price   double precision
5   originalprice   double precision
6   stock   integer
7   product_id  bigint
8   color   varchar
9   sku text

🔎 3. Cột trong bảng reviews

SELECT column_name, data_type
FROM information_schema.columns
WHERE table_name = 'reviews';

🧾 Tổng kết bảng reviews hiện có:

#   Column Name Data Type
1   id  bigint
2   product_id  bigint
3   user_id bigint
4   created_at  timestamp
5   updated_at  timestamp
6   content text

🔎 4. Cột trong bảng variant_sizes (nếu bạn có bảng này)

SELECT column_name, data_type
FROM information_schema.columns
WHERE table_name = 'variant_sizes';

🧾 Tổng kết bảng variant_sizes hiện có:

#   Column Name Data Type
1   id  integer
2   variant_id  bigint
3   size_id integer
4   stock   integer
5   created_at  timestamp
6   updated_at  timestamp

🔎 5. Cột trong bảng categories (nếu có)

SELECT column_name, data_type
FROM information_schema.columns
WHERE table_name = 'categories';

https://guides.rubyonrails.org/association_basics.html https://stackoverflow.com/questions/11600928/when-to-use-a-has-many-through-relation-in-rails https://edgeapi.rubyonrails.org/classes/ActiveRecord/Associations/ClassMethods.html

RAILS_ENV=test rails test test/models
RAILS_ENV=test rails test test/controllers
RAILS_ENV=test rails test test/integration
RAILS_ENV=test rails test test/system

rails credentials:show


markm@MarkM:/mnt/c/Users/manhn/code/shop-php/apps/ruby-rails-boilerplate$ EDITOR="cat" bin/rails credentials:edit
Rails Error: Unable to access log file. Please ensure that /mnt/c/Users/manhn/code/shop-php/apps/ruby-rails-boilerplate/log/development.log exists and is writable (i.e. make it writable for user and group: chmod 0664 /mnt/c/Users/manhn/code/shop-php/apps/ruby-rails-boilerplate/log/development.log). The log level has been raised to WARN and the output directed to STDERR until the problem is fixed.
Editing config/credentials.yml.enc...
# smtp:
#   user_name: my-smtp-user
#   password: my-smtp-password
#
# aws:
#   access_key_id: 123
#   secret_access_key: 345

# Used as the base secret for all MessageVerifiers in Rails, including the one protecting cookies.
secret_key_base: f2dc6dd1e38c7a0368dcd4c6298cd86af6bd5735cb4e7cf2f0a8dfceeaf47a59eb36906aac1f7003dad1c019c731d0016b58ad5e7c6268b9b4b1fca43a07f7d7
File encrypted and saved.

Nếu tất cả 372 variants đều thuộc loại Shoes và mỗi Shoes variant có 10 size, thì:

✅ Tổng số variant_sizes sẽ là:
Copy
Edit
372 variants × 10 sizes = 3,720 variant_sizes
👉 Vậy sau khi chạy task gán size, bảng variant_sizes sẽ có 3,720 bản ghi.


maearon@maearon:~/code/shop-php/apps/ruby-rails-boilerplate$ rails variants:assign_sizes
✅ Assigned 10 sizes to variant 1 (Shoes)
✅ Assigned 10 sizes to variant 2 (Shoes)
✅ Assigned 10 sizes to variant 3 (Shoes)
✅ Assigned 10 sizes to variant 4 (Shoes)
✅ Assigned 10 sizes to variant 5 (Shoes)
✅ Assigned 10 sizes to variant 6 (Shoes)
✅ Assigned 10 sizes to variant 7 (Shoes)
✅ Assigned 10 sizes to variant 8 (Shoes)
✅ Assigned 10 sizes to variant 9 (Shoes)
✅ Assigned 10 sizes to variant 10 (Shoes)
✅ Assigned 10 sizes to variant 11 (Shoes)
✅ Assigned 10 sizes to variant 12 (Shoes)
✅ Assigned 10 sizes to variant 13 (Shoes)
✅ Assigned 10 sizes to variant 14 (Shoes)
✅ Assigned 10 sizes to variant 15 (Shoes)
✅ Assigned 10 sizes to variant 16 (Shoes)
✅ Assigned 10 sizes to variant 17 (Shoes)

......


✅ Assigned 10 sizes to variant 372 (Shoes)

✅ Created product 93: Puma Jersey 93
  Product Count (243.4ms)  SELECT COUNT(*) FROM "products" /*application='RubyRailsBoilerplate'*/
🎉 Seed completed with 93 products!


maearon@maearon:~/code/shop-php/apps/ruby-rails-boilerplate$ rails db:migrate:status | grep carts
maearon@maearon:~/code/shop-php/apps/ruby-rails-boilerplate$ bin/rails db:seed
maearon@maearon:~/code/shop-php/apps/ruby-rails-boilerplate$ rails db:migrate:status | grep carts
maearon@maearon:~/code/shop-php/apps/ruby-rails-boilerplate$ bin/rails rails db:schema:dump

RAILS_ENV=test rails db:drop db:create db:schema:load

RAILS_ENV=test rails db:schema:load
RAILS_ENV=test rails test


maearon@maearon:~/code/shop-php/apps/ruby-rails-boilerplate$ 
maearon@maearon:~/code/shop-php/apps/ruby-rails-boilerplate$ 
maearon@maearon:~/code/shop-php/apps/ruby-rails-boilerplate$ 
maearon@maearon:~/code/shop-php/apps/ruby-rails-boilerplate$ 
maearon@maearon:~/code/shop-php/apps/ruby-rails-boilerplate$ rails c
Loading development environment (Rails 8.0.2)
ruby-rails-boilerplate(dev)> Size.pluck(:label, :system)
  Size Pluck (356.7ms)  SELECT "sizes"."label", "sizes"."system" FROM "sizes" /*application='RubyRailsBoilerplate'*/
=> 
[["XS", "alpha"],
 ["S", "alpha"],
 ["M", "alpha"],
 ["L", "alpha"],
 ["XL", "alpha"],
 ["XXL", "alpha"],
 ["36", "numeric"],
 ["37", "numeric"],
 ["38", "numeric"],
 ["39", "numeric"],
 ["40", "numeric"],
 ["41", "numeric"],
 ["42", "numeric"],
 ["43", "numeric"],
 ["44", "numeric"],
 ["45", "numeric"],
 ["One Size", "one_size"]]
ruby-rails-boilerplate(dev)> Size.group(:system).count
  Size Count (678.6ms)  SELECT COUNT(*) AS "count_all", "sizes"."system" AS "sizes_system" FROM "sizes" GROUP BY "sizes"."system" /*application='RubyRailsBoilerplate'*/
=> {"one_size" => 1, "alpha" => 6, "numeric" => 10}
ruby-rails-boilerplate(dev)> 




http://localhost:3000/rails/info/routes ---> /api/cart?page=1


Không mở editor, tránh bị treo EDITOR=true rails credentials:edit



# Tạo thư mục log và file log nếu chưa có, rồi set quyền
mkdir -p log
sudo touch log/development.log
sudo chmod 0664 log/development.log

# Tạo thư mục tmp/pids nếu chưa có, rồi set quyền
mkdir -p tmp/pids
sudo chmod -R 0775 tmp

sudo chown -R $USER:$USER .


maearon@maearon:~/code/shop-php/apps/ruby-rails-boilerplate$ lsof -i :3000
COMMAND  PID    USER  FD   TYPE DEVICE SIZE/OFF NODE NAME
chrome  4409 maearon  48u  IPv6 300874      0t0  TCP ip6-localhost:55824->ip6-localhost:3000 (ESTABLISHED)
chrome  4409 maearon 138u  IPv6 179729      0t0  TCP ip6-localhost:59310->ip6-localhost:3000 (ESTABLISHED)
maearon@maearon:~/code/shop-php/apps/ruby-rails-boilerplate$ sudo lsof -t -i :3000 | xargs sudo kill -9



docker compose exec api-ruby # rails c 
Loading development environment (Rails 8.0.2)
ruby-rails-boilerplate(dev)> Product.first
  Product Load (232.4ms)  SELECT "products".* FROM "products" ORDER BY "products"."id" ASC LIMIT 1 /*application='RubyRailsBoilerplate'*/
=> 
#<Product:0x00007cd380cd9a30
 id: 1,
 name: "Loose Oversized Shirt",
 jan_code: "08861",
 gender: "Men",
 franchise: "Tubular",
 producttype: "Wear",
 brand: "Originals",
 category: "Shoes",
 sport: "Running",
 description_h5: nil,
 description_p: nil,
 specifications: nil,
 care: nil,
 created_at: "2025-06-09 09:33:39.611675000 +0000",
 updated_at: "2025-06-09 09:33:39.611675000 +0000">
ruby-rails-boilerplate(dev)> 

ruby-rails-boilerplate(dev)> Product.first.variants.count
  Product Load (235.1ms)  SELECT "products".* FROM "products" ORDER BY "products"."id" ASC LIMIT 1 /*application='RubyRailsBoilerplate'*/
  Variant Count (236.8ms)  SELECT COUNT(*) FROM "variants" WHERE "variants"."product_id" = 1 /*application='RubyRailsBoilerplate'*/
=> 4
ruby-rails-boilerplate(dev)> Product.first.variants.first
  Product Load (236.1ms)  SELECT "products".* FROM "products" ORDER BY "products"."id" ASC LIMIT 1 /*application='RubyRailsBoilerplate'*/
  Variant Load (240.6ms)  SELECT "variants".* FROM "variants" WHERE "variants"."product_id" = 1 ORDER BY "variants"."id" ASC LIMIT 1 /*application='RubyRailsBoilerplate'*/
=> 
#<Variant:0x00007cd380207f80
 id: 1,
 color: "Black",
 price: 65.0,
 originalprice: 90.0,
 sku: "AQ0886",
 stock: 1000,
 product_id: 1,
 created_at: "2025-06-09 09:33:39.916636000 +0000",
 updated_at: "2025-06-09 09:34:01.255263000 +0000">

docker compose exec api-ruby bundle exec rake products:reindex

Description

Rails REST API boilerplate for typical project can connect and interact with Posgres default by Prisma

Features

[x] Database (activerecord).
[x] Seeding.
[x] Config Service (rails/config).
[x] Mailing (activemail).
[x] Log in and sign up via email.
[x] Social log in (Apple, Facebook, Google, X).
[x] Admin and User roles.
[x] I18N (rails-i18n).
[x] File uploads. Support local and Amazon S3 drivers.
[x] Swagger.
[x] E2E and units tests.
[x] Docker.
[x] CI (Github Actions).

Quick run

git clone --depth 1 [email protected]:maearon/rails-boilerplate.git my-app
cd my-app/
cp env-example .env
docker compose up -d

For check status run

docker compose logs

Comfortable development

git clone --depth 1 https://github.com/brocoders/nestjs-boilerplate.git my-app
cd my-app/
cp .env-example .env
cp client/env-example client/.env

Change DATABASE_HOST=postgres to DATABASE_HOST=localhost

Change MAIL_HOST=maildev to MAIL_HOST=localhost

Run additional container:

docker compose up -d postgres redis

bundle

rails db:drop

cd client &&
npx prisma generate && 
npx prisma migrate dev (rails db:migrate)

manhpc@manhpc-B660M-D3H-DDR4:~/code/ruby-rails-boilerplate/client$ npx prisma migrate dev
Environment variables loaded from .env
Prisma schema loaded from prisma/schema.prisma
Datasource "db": PostgreSQL database "adidas_product_prod", schema "public" at "ep-bold-voice-a4yp8xc9.us-east-1.aws.neon.tech:5432"

Applying migration `20240722050134_ruby_rails_boilerplate_development`

The following migration(s) have been applied:

migrations/
  └─ 20240722050134_ruby_rails_boilerplate_development/
    └─ migration.sql



Your database is now in sync with your schema.

Running generate... (Use --skip-generate to skip the generators)

✔ Generated Prisma Client (v5.17.0) to ./node_modules/@prisma/client in 130ms


manhpc@manhpc-B660M-D3H-DDR4:~/code/ruby-rails-boilerplate/client$ 
 1953  git checkout 6757f51096580846978602258ea87eabee204ef2 -- Dockerfile
 1954  git status
 1955  git checkout 6757f51096580846978602258ea87eabee204ef2 -- docker-compose.yml


bin/rails db:seed (prisma introspect && npx prisma db pull && npx prisma db push)
cd ..
rails s -p 3001
(git checkout 1242dc57c527178d6bffd6980c884ba4478bafd4 -- db/migrate)
(rails status code symbol: https://gist.github.com/mlanett/a31c340b132ddefa9cca)

Links

Routes: http://localhost:3001/rails/info/routes
Adminer (client for DB): http://127.0.0.1/pgadmin4/browser/ (npx prisma studio)
Maildev: http://localhost:3001/letter_opener

Automatic update of dependencies

If you want to automatically update dependencies, you can connect Depfu for your project.

Database utils

Generate migration

rails generate migration CreateNameTable

Run migration

rails db:migrate

Revert migration

rails db:migrate:reset

Drop all tables in database

rails db:drop

Run seed

bin/rails db:seed

Tests

# unit tests
rails t

# e2e tests
./node_modules/.bin/cypress run

Tests in Docker

docker compose -f docker-compose.ci.yaml --env-file env-example -p ci up --build --exit-code-from api && docker compose -p ci rm -svf

Test benchmarking

docker run --rm jordi/ab -n 100 -c 100 -T application/json -H "Authorization: Bearer USER_TOKEN" -v 2 http://<server_ip>:3001/api/v1/users

Test graphql

curl -X POST http://localhost:3000/graphql   -H "Content-Type: application/json"   -d '{"query": "{ users { id name } }"}'
ngrok http 3000
https://studio.apollographql.com/sandbox/explorer
https://aa9e-2001-ee0-4422-98f0-73c6-d4af-616c-fc1.ngrok-free.app/graphql
https://ruby-rails-boilerplate-3s9t.onrender.com/graphql
query GetUsers {
  users {
    id
    name
  }
}

ruby-rails-boilerplate

About ruby-rails-boilerplate

Platforms

Languages

Links

README.md

Rails REST API + NextJS boilerplate 🇻🇳

Description

Table of Contents

Features

Quick run

Comfortable development

Links

Automatic update of dependencies

Database utils

Tests

Tests in Docker

Test benchmarking

Test graphql