Skip to content

Latest commit

 

History

History
91 lines (68 loc) · 4.14 KB

README.md

File metadata and controls

91 lines (68 loc) · 4.14 KB
Raw

Trapper Keepr ~ V1

A full-stack Rails based address book.

Description

A fullstack Rails app that demonstrates CRUD capabilities, authentication and authorization and uses custom CSS. Live version ~> TrapperKeepr

The Why

Created to act as demonstrator for a mobile compatible fullstack Rails app. It utilizes the devise gem for authorization and authentication, Bootstrap for styling, Postgresql for database purposes, Heroku for hosting and a configured cron-job to heroku based readily available ( had to update this to fly.io due to Herkou's new policies).

Screenshots/Demo

ScreenShot of the app

Built With

Local Start/Initialization

Tests

Features

  • Users can create, update and delete a profile for theirselves, it also has the capability for password recovery.
  • Users have the ability to create profiles, update profiles for their friends and delete these profiles.

Issues

Acknowledgments

  • Meg Gutshall ~ for this ReadMe template and pointers to figure out whats wrong.
  • Mike Rogers ~ for being my go-to person when stuff breaks and I need another pair of eyes.
  • Tun ~ helping me when the structure of things are off.
  • Alex ~ pushing me to become a better dev.

License

This project is licensed under the MIT License. MIT License

Copyright (c) [2021~2023] Nerajno

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.

Bugs\Todos

  • Add user's actual name to home/index page as a greeting.
  • Format the navbar for a better look.... Remove Search item.
  • Add thing to rails app to keep it awake on Heroku.
  • Get it reviewed by others.
  • Get it reviewed by others.... again
  • Write a completed ReadMe ~ See below.
  • Integrate tests via capybara.
  • Create a local start/localhost set
  • Add CI/CD or action for continous deployment via github to fly.io.
  • 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.
  • Add other use cases to this ReadMe.
  • Add a version badge.
  • Add a website up or down badge.
  • Change colors via color theory to fit the project's target audience.
  • Fix about us and the other page.

Work status

  • V1 is done and up.