Self-hosted project management for devs and their clients: tickets, time tracking, docs and meetings, with an AI assistant that cites its sources. AGPL-3.0.
Ruby agplai-assistantdockerdsgvogdprhotwireissue-trackerjira-alternativeknowledge-basellmmcp-servermeeting-notesopen-sourceproject-managementredmine-alternativeruby-on-railsself-hostedticketingtime-tracking
Repository Guidelines
Project Structure & Module Organization
- app/: Rails code (models, controllers, views, ViewComponents in
app/components, policies, services, jobs, javascript Stimulus controllers). - config/: environment, routes, initializers. db/: migrations and seeds. lib/: utilities.
- spec/: RSpec tests (unit, request, system). public/: static assets.
- bin/: entrypoints (
bin/dev,bin/rspec,bin/rubocop,bin/setup).
Build, Test, and Development Commands
bin/setup: install gems, prepare database, clear tmp/log.bin/dev: start app via Foreman usingProcfile.dev(Rails server, Tailwind watch, Solid Queue).bin/rails db:setup|db:migrate|db:seed: database lifecycle (PostgreSQL).bin/rails tailwindcss:build: build the Tailwind CSS.npm run copy:fonts: copy the Bootstrap Icons fonts topublic/fonts(once afternpm install).bin/rspec [path]: run test suite (add a path to scope).bin/rubocop: lint/format Ruby per.rubocop.yml.bundle exec erblint app/views: lint ERB.bin/brakeman: security scan.
Coding Style & Naming Conventions
- Ruby: 2-space indent; follow RuboCop Rails Omakase. Keep methods small and object-oriented (policies/services/components).
- ViewComponents: place in
app/components, namesomething_component.rbwith matching.html.erbtemplate; keep inputs explicit. - Stimulus: controllers in
app/javascript/controllers, namedthing_controller.js; data-attributes in kebab-case. - Tests/files: snake_case for files; classes/modules in CamelCase; controllers plural, models singular.
Testing Guidelines
- Frameworks: RSpec + Capybara + Shoulda Matchers + FactoryBot. Prefer fast unit tests; add request/system specs for flows.
- Conventions:
*_spec.rbunderspec/(e.g.,spec/models/user_spec.rb,spec/system/login_spec.rb). Component specs inspec/components/. - Running:
bin/rspecfor all; use tags like:systemwhen needed. Database cleaning is configured viadatabase_cleaner.
Commit & Pull Request Guidelines
- Commits: Conventional style (e.g.,
feat(scope): ...,fix: ...,chore: ...,docs: ...,refactor: ...). One logical change per commit. - PRs: clear description, link issues, note migrations, include screenshots/GIFs for UI/ViewComponent changes, and add/adjust tests.
- Pre-push checks:
bin/rspec && bin/rubocop && bundle exec erblint app/views && bin/brakeman && bin/rails tailwindcss:build.
Security & Configuration Tips
- Env: copy
.env.exampleto.env; never commit secrets. Use Pundit policies and add policy specs for new permissions.
Documentation location
- The maintainers' internal plans, work logs and reviews live outside this repository. Do not create
doc/ordocs/here, and do not recreate a file a comment refers to under those paths. - Comments that name
doc/...ordocs/...point to that internal archive; it is not part of the public repository. - User help and self-hosting guides are a separate documentation project; this repository holds no copy.
app/services/docs/andspec/fixtures/docs_catalogue/are application code and test data, not part of that archive.