This README would normally document whatever steps are necessary to get the application up and running.
Things you may want to cover:
-
Ruby/Rails version
- Ruby: 3.3.0
- Rails: 7.1.2
-
System dependencies
- Node 20
- yarn
-
Configuration
-
Database creation
-
Database initialization
-
How to run the test suite
-
Services (job queues, cache servers, search engines, etc.)
-
Deployment instructions
- User - focused on the user
- Submission - The creates this
- Community - Category based on submissions
- Comments - A place for a friendly chats below posts. Allows users to talk with each other.
- Subscription - The user joins a community.