MVP

README.md

@@ -4,162 +4,81 @@
 
 ### Description
 
->A little info about your project and/or overview that explains **what** the project is about.
+A fullstack Rails app that demonstrates CRUD capabilities, authentication and authorization and uses custom CSS.
+Live version ~> [TrapperKeepr](https://trapperkeepr.herokuapp.com/)
 
-### The Why
 
->A short description of the motivation behind the creation and maintenance of the project. This should explain **why** the project exists.
+### The Why
+Created to act as demonstrator for a mobile compatible fullstack Rails app. It utlizes the [devise gem](https://github.com/heartcombo/devise) for authorization and authentication, Bootstrap for styling, Postgresql for datbase purposes, Heroku for hosting and a configured cron-job to heroku based readily available.
 
 ## Screenshots/Demo
 
->Include logo, demo, screenshot etc.
 
 ## Built With
 
->List of tech languages, frameworks/libraries, and tools used
-
-- [Language](link to language documentation)
-- [Framework](link to framework documentation)
-- [Database](link to database documentation)
+- [Ruby](https://ruby-doc.org/) ~ this app utilises Ruby 3.0.0.
+- [Rails](https://guides.rubyonrails.org/)
+- [Postgresql](https://www.postgresql.org/docs/13/index.html) ~ this app utilises vesion 12 of Posgresql.
+- [Heroku](https://devcenter.heroku.com/articles/getting-started-with-rails6) ~ Hosting.
+- [Bootstrap](https://dev.to/antman/using-bootstrap-4-in-rails-6-39hk) ~ specifically [Bootstarp Ruby Gem](https://github.com/twbs/bootstrap-rubygem)
+- [Devise gem](https://github.com/heartcombo/devise) ~ for authorization/authentication.
 
 ## Features
 
->What makes your project stand out? What pain points does it solve for the prospective user? Compare it to competitor apps/tools to show how it is different/better.
-
-
-## Build Status and Code Style
-
->Build status of continuous integration (travis, appveyor, etc.) and code style (xo, standard etc.). This will help others who wish to contribute to your project. You can include badges here as well, just don't go too crazy or it looks like a mess.
-
-## Getting Started
-
-These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
-
-### Prerequisites
-
->List which technologies the user needs to install the software and how to install these dependencies.
-
-#### <Software Name>
-
->Links to resources and installation instructions. Include code examples. Break instructions down by operating system if necessary.
-
-<!-- ##### For Mac Users -->
-
-<!-- ##### For Windows Users -->
-
-<!-- ##### For Linux Users -->
-
-### Installation
-
->This section tells the user how to get a local environment running. Be sure to include specific step-by-step instructions for the installation process to accommodate coders of all levels.
->This section will vary greatly depending on the type of code the repository contains. For example, a Node package is usually installed by typing `npm install <package-name>` in the terminal, whereas other projects you may have to fork and clone down the repository. In both cases the user needs to have the requisite technology installed to run to code. Even with a Docker image, the user still needs to be able to run Docker on their machine.
->Keep this in mind when writing out the "Prerequisites" and "Installation" sections.
-
-## API Reference/Documentation
-
->Depending on the size of the project, if it is small and simple enough the reference docs can be added to the `README`. For medium size to larger projects it is important to at least provide a link to where the API reference docs live.
-
-## Tests/End-to-End Tests
-
->Explain how to run the automated tests for this system.
->Explain what these tests test and why. Include code examples.
-
-
-## Contributing
+- Users can create, update and delete a profile for their selves, it also has the capability for password recovery.
+- Users have the ability to create profiles, update profiles for their friends and delete these profiles.
 
->Add more detailed instructions for open-source projects. It's a good idea to include a code of conduct as well as resource links as to where absolute beginners can go to learn how to contribute to open source. [Here's a great place to start.][Open Source Guides]
->I personally like the Contributor Covenant and use the below statement as my default. I intend to expand on it once I create an open-source project truly worthy of others' contributions.
-
-Issues and pull requests are welcome at [<!-- repo title -->](<!-- link to repo -->). This project as well as all other content on my GitHub are intended to be safe, welcoming, and open for collaboration. Users are expected to adhere to the [Contributor Covenant code of conduct](https://www.contributor-covenant.org/version/2/0/code_of_conduct/) and those that do not will be reported and blocked. I got no time for that nonsense.
-
-## Authors
-
->Include your name and any links to your social media, contact info, or websites that you'd like. Don't forget to s/o your contributors here too!
-
-**[Meg Gutshall](https://github.com/meg-gutshall/)**
-
-See also the list of [contributors](#contributors) who participated in this project.
-
-## Contributors/How todos
-
->Add a list of contributors here. You may want to feature some who have really stood out.
 
 ## Acknowledgments
+**[Meg Gutshall](https://github.com/meg-gutshall/)** ~ for this ReadMe template and pointers to figure out whats wrong.
+**[Mike Rogers](https://mikerogers.io/)** ~ for being my go-to person when stuff breaks and I need another pair of eyes.
+**[Tun](https://github.com/tunkhine126)** ~ helping me when the structure of things are off.
+**[Alex](https://github.com/meg-gutshall/)** ~ pushing me to become a better dev.
 
->- Hat tip to anyone whose code was used
->- Inspiration
->- Anything else that seems useful
 
 ## License
 
->Include your license here. This is an absolute **must** as some users require that all services they include in their project have a license that matches their own. The MIT License is GitHub's recommendation and probably the most common one you'll see in repos, but there are [other options available][Choose an Open Source License]—copy*left*, anybody?—and that's not even an exhaustive list, just the most popular licenses on GitHub.
-
-This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details.
-
----
-
-## Template Resources
-
-### Articles About Writing READMEs
+This project is licensed under the MIT License.
+MIT License
 
-- [A Beginner's Guide to Writing a Kickass README][A Beginner's Guide to Writing a Kickass README]: A short and sweet summary with many examples at the end.
-- [Art of README][Art of README]: An informational repo on the what and why behind `README`s.
+Copyright (c) [2021~2023] [Nerajno](https://twitter.com/nerajno)
 
-[A Beginner's Guide to Writing a Kickass README]: https://medium.com/@meakaakka/a-beginners-guide-to-writing-a-kickass-readme-7ac01da88ab3
-[Art of README]: https://github.com/noffle/art-of-readme
+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:
 
-### README Templates that Won the Meg Stamp of Approval
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
 
-- [Standard README][Standard README]: I like the simplicity with the extensive use of links.
-- [Open-Source Template][Open-Source Template]: Figured I'd throw this in here in case it comes in handy for anyone.
-- [Awesome README][Awesome README]: Another Awesome List—`README` Edition.
+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.
 
-[Standard README]: https://github.com/richardlitt/standard-readme
-[Open-Source Template]: https://github.com/davidbgk/open-source-template/
-[Awesome README]: https://github.com/matiassingers/awesome-readme
-
-### Repository Licenses
-
-- [Choose an Open Source License][Choose an Open Source License]: A non-exhaustive list of licenses curated by GitHub.
-- [Searching GitHub by License Type][Searching GitHub by License Type]: You can filter repositories based on their license or license family using the `license` qualifier and the exact license keyword
-- [The Legal Side of Open Source][The Legal Side of Open Source]: Everything you've ever wondered about the legal side of open source, and a few things you didn't.
-
-[Choose an Open Source License]: https://choosealicense.com/
-[Searching GitHub by License Type]: https://docs.github.com/en/free-pro-team@latest/github/creating-cloning-and-archiving-repositories/licensing-a-repository#searching-github-by-license-type
-[The Legal Side of Open Source]: https://opensource.guide/legal/
-
-### Open Source
-
-- [Open Source Guides][Open Source Guides]: Open source software is made by people just like you. Learn how to launch and grow your project.
+---
 
-[Open Source Guides]: https://opensource.guide/
 
 ### Bugs\Todos
-- [x] Add user's actual name to home/index page.   
-- [ ] Change colors via color theory to fit the project's taget audience.
+- [x] Add user's actual name to home/index page. 
 - [x] Format the navbar for a better look.... Remove Search item.
+- [x] Add thing to rails app to keep it awake on Heroku.  
+- [x] Get it reviewed by others.
+- [ ] Get it reviewed by others.... again
+- [ ] Change colors via color theory to fit the project's target audience.
 - [ ] Fix about us and the other page.
-- [x] Add thing to rails app to keep it awake on Heroku.
-- [ ] Write a completed ReadMe ~ See below.
+- [x] Write a completed ReadMe ~ See below.
 - [ ] Integrate tests.
-- [x] Get it reviewed by others.
-- [ ] Add CI/CD or action for continous deployment via github to Heroku.
+- [x] Add CI/CD or action for continous deployment via github to Heroku.
 - [ ] Add image uploader/avatar generator for each friend created. 
 - [ ] Add image uploader/avatar generator for each user created. 
-- [ ] Add user stories and do a sketch for app usage. 
-
-
-
-### ReadMe Creation
-This README would normally document whatever steps are necessary to get the
-application up and running.
+- [ ] ~Add user stories and do a sketch for app usage. 
+- [ ] Add other usecases to this ReadMe.  
+- [ ] Add a version badge.
+- [ ] Add a website up or down badge.
 
-Things you may want to cover:
-* Ruby version
-* System dependencies
-* Configuration
-* Database creation
-* Database initialization
-* How to run the test suite
-* Services (job queues, cache servers, search engines, etc.)
-* Deployment instructions

app/views/home/_header.html.erb

@@ -1,5 +1,5 @@
 <nav class="navbar navbar-expand-lg navbar-dark bg-dark">
-<%= link_to 'Friend App', root_path, class:"navbar-brand" %>
+<%= link_to 'Trapper Keepr', root_path, class:"navbar-brand" %>
   <div class="container-fluid justify-content-end">
     <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbarSupportedContent" aria-controls="navbarSupportedContent" aria-expanded="false" aria-label="Toggle navigation">
       <span class="navbar-toggler-icon"></span>

log/development.log

@@ -1235,3 +1235,23 @@ Processing by FriendsController#index as HTML
 Completed 200 OK in 2972ms (Views: 2970.1ms | ActiveRecord: 0.0ms | Allocations: 73483)
 
 
+Started GET "/" for ::1 at 2021-03-15 08:20:45 -0400
+   (0.7ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" ORDER BY "schema_migrations"."version" ASC
+Processing by FriendsController#index as HTML
+  Rendering friends/index.html.erb within layouts/application
+  Rendered friends/index.html.erb within layouts/application (Duration: 4.3ms | Allocations: 654)
+[Webpacker] Everything's up-to-date. Nothing to do
+  Rendered home/_header.html.erb (Duration: 1.3ms | Allocations: 561)
+Completed 200 OK in 3875ms (Views: 3867.1ms | ActiveRecord: 0.0ms | Allocations: 105180)
+
+
+Started GET "/users/sign_in" for ::1 at 2021-03-15 08:21:13 -0400
+Processing by Devise::SessionsController#new as HTML
+  Rendering devise/sessions/new.html.erb within layouts/application
+  Rendered devise/shared/_links.html.erb (Duration: 2.0ms | Allocations: 605)
+  Rendered devise/sessions/new.html.erb within layouts/application (Duration: 13.8ms | Allocations: 4837)
+[Webpacker] Everything's up-to-date. Nothing to do
+  Rendered home/_header.html.erb (Duration: 1.4ms | Allocations: 200)
+Completed 200 OK in 62ms (Views: 36.2ms | ActiveRecord: 9.5ms | Allocations: 19000)
+
+