🛑 TODO: REPLACE WITH A PICTURE OF YOUR PROJECT LOGO AND RETURN OUR MANGO
🛑 TODO: PLEASE REPLACE
Insert App Summary (1-2 paragraphs) and list out main facets of the application with brief descriptions
- Build Status
- Environment Setup
- Primary Function One
- Primary Function Two
- Primary Function Three
- Password Log
- DB Schema
- Testing
- Visual Design Philosophy
- External Services
- Contributing
- License
- Acknowledgements
🛑 TODO: PLEASE CUSTOMIZE AS NEEDED
This application is using:
- Ruby 2.6.6
- Rails 6.1.3
🛑 TODO: PLEASE CUSTOMIZE AS NEEDED
In your terminal, run the following to clone the project onto your local machine:
git clone git@github.com:organization/project.git
🛑 TODO: PLEASE CUSTOMIZE AS NEEDED
For the final setup for the packages, gems, remotes, prepping databases, and seed file, run the following:
bin/setup
❗️ Remember to add the required API keys for: WhicheverAPIYouUse
Note: Ask your Lead Dev for the required keys or single secret key
Insert some text to explain this facet or function of the app, make sure to include plenty of photos
Some subheaders to include are:
Insert some text to explain this facet or function of the app, make sure to include plenty of photos
Some subheaders to include are:
Insert some text to explain this facet or function of the app, make sure to include plenty of photos
Some subheaders to include are:
🛑 TODO: PLEASE CUSTOMIZE AS NEEDED
🛑 TODO: REPLACE WITH A PICTURE OF YOUR ER DIAGRAM AND RETURN OUR MANGO
🛑 TODO: PLEASE CUSTOMIZE AS NEEDED
To run the test suite run:
bundle exec rspec
To view the coverage report run:
open coverage/index.html
🛑 TODO: REPLACE WITH PICTURES OF YOUR TEST RUNS AND RETURN OUR MANGO
Testing philosophy is based off off the Classic Approach or Chicago School a.k.a Inside Out TDD.
The levels covered range from unit/models, requests, and features. It also includes additional coverage along jobs, mailers, presenters, and services.
The primary toolset is managed by rspec; test data is managed by factorybot; coverage is managed by simplecov; cleaning is managed by database_cleaner; and additional services are provided by shoulda-matchers.
The primary web driver is handled by capybara.
If you implement any new features please validate all tests pass prior to pushing your branch. If you submit a pull request please validate all test pass successfully on the github action workflow. You should see a green check by the last commit if all tests have passed.
🛑 TODO: PLEASE REPLACE AND/OR MODIFY
Please provide a visual representation of your app either through a prototype such as figma or through a series of images.
In 1-2 paragraphs please also describe the visual design philosophy such as patterns you'll be using (gradeints, glassmorphism, etc), coding practices (BEM model), and potentially any frameworks (tailwind, bootstrap, bulma, etc)
We've generated a Kitchensink route, controller action, and view to populate with front-end components. Every time you are using a component make sure you use the ones from the kitchen sink (or add them if you are creating new ones).
- Please
- Provide
- The List Of
- External
- Services
- Used
If you are joining the team and wish to contribute please follow three simple philosophies
- Maintain code coverage levels, following the inside out approach
- Descriptive pull requests using the built in template, and no one merges their own requests
- Follow any and all design patterns or philosophies when available
🛑 TODO: PLEASE REPLACE AND/OR MODIFY
Copyright © 202X COMPANY NAME
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Rails app generated with BambooSticks.
Developed & Designed with love by MangoTree Dev Agency