mmandelb2201 / finance-bot

SSW345 Bot
1 stars 1 forks source link

financebot

https://finance-bot-cae6d.web.app/

What is financebot?

financebot is a website where users can get recommendations on how to improve their financial situation. Users put in basic information about themselves, then the bot gives them curated suggestions on what they can do better.

How was financebot made?

financebot is made using React for front-end components and routing. React-Bootstrap is being used as our CSS framework. All user data and authentication is being done using google firebase. The website is also being hosted on google firebase servers. The bot and all components were created in Javascript.

How to run financebot locally?

  1. Clone the repository into a local directory.
  2. cd into the directory.
  3. Run npm install --legacy-peer-deps.
  4. Run npm start
  5. The website is now hosted locally at http://localhost:3000/
    Note: If you're currently on node version 17 or higher, you must change the start script in package.json to "start": "react-scripts --openssl-legacy-provider start"

Created By

  1. Matthew Mandelbaum
  2. Dylan James
  3. Mikayla Mount
  4. Jack Corridon

MIT License

Copyright (c) 2022

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.