Instautomation

Requirements

You can see how to check these under "Local Setup" point 4.

• Ruby 2.7.2
• Rails 6.0.3.4
• Node.js 12.x
• Yarn 1.22.x
• SQLite3 3.28.0

Setup

Repository Setup ✨

1. Fork this repository
2. In the menu on top, click on "Code" (first on the left): find .github/workflows, click on it and then click on ci-setup.yml, copy the content
3. In the menu on top, click on "Actions" (third from the left): You will see a message and need to click on the green button "I understand my workflows, go ahead and enable them"
4. Click on the blue button "New Workflow" and on the next page, click on "set up a workflow yourself ->", then chose a name for the file and replace the content of the file with the copied content from point 2, then click on the green button "Start commit"
5. Go back to "Actions" - you should see some results in the list there - congrats! Your CI pipeline is set up!!

Run Instautomation locally (on your machine)

1. Clone that repository from your own account: https://github.com/[your-username]/instautomation.git
2. Open the terminal/command line, then type cd instautomation
3. Check whether you have all your dependencies installed:
   • ruby -v
   • rails -v
   • node -v
   • yarn -v
   • sqlite3 --version
4. Run the setup script: bin/setup
5. Run Tests: rails test -v
6. Run System Tests: rails test:system -v
7. Start the server: rails server
8. Open in your browser: http://127.0.0.1:3000
9. You should see "Instautomation website" showing up in the browser 🎉

How to run tests?

In the terminal, type rails test or rails test -v

Or run an individual test with rails test path/to/individual_test_rb or rails test -v path/to/individual_test_rb

-v, --verbose Verbose. Show progress processing files.

System Tests

By default, running rails test won't run system tests, so we need to use:

rails test:system

Deployment

• Production: Deployments are triggered manually in Heroku.
• PR: With every PR that is opened, a Review App is created in Heroku with a deployment of the code from the PR.

With credits to ❤️

• Font Awesome
• Bootstrap
• Subtle Patterns

References 💡

• Ruby on Rails Guides
• Ruby on Rails Guides > Testing
• Rails Girls App Tutorial