Skip to content

Instantly share code, notes, and snippets.

@0bserver07
Last active November 8, 2018 22:53
Show Gist options
  • Save 0bserver07/0ad90f07086142491816 to your computer and use it in GitHub Desktop.
Save 0bserver07/0ad90f07086142491816 to your computer and use it in GitHub Desktop.
Project descriptions
Project Name
This application was for XYZ, provided by the XYZ Team.
Diagnostics
This application was built with recipes XYZ that are known to ....
This application was built with preferences that are NOT known to work together.
If the application doesn’t work as expected, please https://github.com/XYZ Project/issues and include these diagnostics:
We’d also like to know your setup.
Recipes:
deployment
rvm
Setup:
dev_webserver: thin
prod_webserver: thin
database: postgresql
templates: erb
tests: rspec
continuous_testing: none
frontend: bootstrap3
email: mandrill
authentication: devise
devise_modules: confirmable
authorization: none
form_builder: simple_form
pages: about+users
locale: none
rvmrc: true
quiet_assets: true
better_errors: true
ban_spiders: true
Ruby on Rails
This application requires:
Ruby
Rails
Database
This application uses PostgreSQL with ActiveRecord.
Development
Template Engine: ERB
Testing Framework: RSpec
Front-end Framework: Bootstrap 3.0 (Sass)
Form Builder: SimpleForm
Authentication: Devise
Authorization: None
Admin: None
Email
The application is configured to send email using a Mandrill account.
Email delivery is disabled in development.
Getting Started
Lorem ipsum dolor sit amet, consectetur adipiscing elit.
Documentation and Support
This is the only documentation.
Issues
Lorem ipsum dolor sit amet, consectetur adipiscing elit.
Similar Projects
Lorem ipsum dolor sit amet, consectetur adipiscing elit.
Contributing
If you make improvements to this application, please share with others.
Fork the project on GitHub.
Make your feature addition or bug fix.
Commit with Git.
Send the author a pull request.
If you add functionality to this application, create an alternative implementation, or build an application that is similar, please contact me and I’ll add a note to the README so that others can find your work.
Credits
Lorem ipsum dolor sit amet, consectetur adipiscing elit.
License
Lorem ipsum dolor sit amet, consectetur adipiscing elit.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment