This README would normally document whatever steps are necessary to get the application up and running.
Things you may want to cover:
-
Ruby version
-
System dependencies
bundle lock --add-platform x86_64-linux Gemfile
bundle config --local build.mysql2 "--with-ldflags=-L/usr/local/opt/openssl@1.1/lib --with-cppflags=-I/usr/local/opt/openssl@1.1/include"
bundle install
bundle cache --all
bundle package --all-platforms
- Configuration
bin/docker --help
bin/docker setup
- Setup env
bin/redis start --publish
bin/db start --publish
- Database creation
bin/rails db:setup
- Database initialization
bin/rails db:setup
- App Skeleton
bin/rails generate scaffold post name:string
bin/rails db:migrate
- Test app
bin/rails server
curl --location --request POST 'http://127.0.0.1:3000/posts' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data-raw '{
"post": {
"name": "Case of the Missing Green Journals",
}
}'curl -X GET \
-H "Accept: application/json" \
-H "Content-type: application/json" \
http://127.0.0.1:3000/posts | jq- How to run the test suite
bin/rails test
-
Services (job queues, cache servers, search engines, etc.)
-
Deployment instructions
-
...