README template to get you started on a Rails application

project_readme_template.md

📚 Project Name

Project description goes here

DROP SCREENSHOT HERE
App home: https://WHATEVER.herokuapp.com

Getting Started

Setup

Install gems

bundle install

ENV Variables

Create .env file

touch .env

Inside .env, set these variables. For any APIs, see group Slack channel.

CLOUDINARY_URL=your_own_cloudinary_url_key

DB Setup

rails db:create
rails db:migrate
rails db:seed

Run a server

rails s

Built With

• Rails 7 - Backend / Front-end
• Stimulus JS - Front-end JS
• Heroku - Deployment
• PostgreSQL - Database
• Bootstrap — Styling
• Figma — Prototyping

Acknowledgements

Inspired by Jane Mount's Bibliophile and a story my father once told me: "Why do we keep books? ... We keep books because they remind us of the new perspectives and lessons we learned".

Team Members

• Douglas Berkley

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

License

This project is licensed under the MIT License