From 7c71f4a0ad93fc7ca1ec8aa96da7bc0b63420241 Mon Sep 17 00:00:00 2001 From: bionickatana Date: Wed, 16 Sep 2026 16:45:47 -0600 Subject: [PATCH] Updated README --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/README.md b/README.md index ba13c9e..033c9ce 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,28 @@ Vehicle maintenance and fuel tracking application. + +## Initial setup + +Start the rails server with `bin/rails server` in the cloned repo + +In a new terminal where the repo is cloned run `bin/rails console` This will open an interactive console. You can get the current server key with `AccessKey.current.raw_key`. This is needed to log a user in. By default the key is rotated every 30 days but this can be configured. See the complete list of commands in the (Key management) section + +Navigate to localhost:3000 in your browser to be able to see the website. + +## Key management + +```ruby +AccessKey.current.raw_key +AccessKey.rotate! +AccessKey.current.disable_auto_rotation! +AccessKey.current.enable_auto_rotation! +AccessKey.current.auto_rotation_frequency_days +AccessKey.current.update!(auto_rotation_frequency_days: 60) +``` + + + ## Testing Run the application test suite with: