KeithWesley254 / txc-fort-base-react-rails

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Project Name:

TXC FortBase Fanbase Application

Author:

KEITH WESLEY

Description:

TXC FortBase is a fandom page for people who want to connect with the heroes of the nation. You can get information about the latest technologies in the TXC military and public researches. Come and Connect

Technology used

  1. React.js
  2. Ruby on Rails
  3. Postgresql


  1. Material Ui for the frontend
  2. JWT for authentication

User Story:

  1. As Keith Wesley, I want users to connect to their heroes on the battlefield and send motivational messages to them. I want to bridge the gap between soldiers and the population and make joining the military a more enticing choice of a career to those who may not see it that way.
  2. The military would benefit from a fanbase as it will raise troop morale, they will have a place where their comrades will be commemorated and have the general population want to join the army which will be of great use to their recruitment process.
  3. In the case of a user, a user can do the following:
    ○ Leave a comment
    ○ Update their profile
    ○ Delete their profile
    ○ Login and logout
    ○ View technology and stories
    ○ View Soldiers and generals
    ○ Any other information that may be added in the future for users

Setup Instructions:

  1. The application requires a user to sign up to access the full website. Features have been explained and some made intuitive for the user.
  2. Use image urls for image upload fields as active storage is not active for this application.


Report any bugs so that they may be fixed in the next versions.

Deployment Link:

https://txc-fortbase.netlify.app/

License:

MIT License

Copyright (c) 2022 Keith Wesley

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.

About

License:MIT License


Languages

Language:Ruby 94.0%Language:JavaScript 4.7%Language:HTML 1.2%Language:Shell 0.1%