Skip to content

Instantly share code, notes, and snippets.

@dmbf29

dmbf29/project_readme_template.md

Last active March 18, 2024 11:04
Show Gist options
  • Star 4 You must be signed in to star a gist
  • Fork 6 You must be signed in to fork a gist
  • Save dmbf29/c0ce5775145db9a0475efad433286036 to your computer and use it in GitHub Desktop.
Save dmbf29/c0ce5775145db9a0475efad433286036 to your computer and use it in GitHub Desktop.
Download ZIP
README template to get you started on a Rails application
Raw
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

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

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment