Battle-Brands is a collect-em-all style digital pet application in which a user can store and interact with different digital creatures, inspired by classic handheld games like the original digimon cubes. A user can sign up, creating a battle-brands account, after which they will be directed to their personal profile page and meet their first creature - a battle-brands pet! Once an account has been created a user can then link their Facebook and LinkedIn accounts to recieve the corresponding pet! For testing purposes we have included a myriad of other creatures a user can select from reputable tech brands.
- Clone the repository from the following link
- Ensure you have Node.js installed by running the command node -v. You should see a version number print out.
- Open up a terminal in the root directory and run npm install to install all of our required node dependancies.
- If working on the deployed version of the application, open up the public/assets/js/creature/updateCreature.js file and change the value of the root variable to represent the correct host (For our deploy, https://battle-brands.herokuapp.com)
- If working locally, ensure that the host value is localhost:3001
- Finally using the command node server.js will start up the server, and the application can be found live on the given host.
- If simply visiting the most updated version of the application, simply navigate to https://battle-brands.herokuapp.com/
This application requires a few node dependancies listed below:
- Express.js
- Express-session
- Express-handlebars
- MySQL2
- Sequelize
- Connect-session-sequelize
- Passport.js
- Passport-Facebook
- Passport-LinkedIn
- Passport-LinkedIn-Oauth2
- Fontawesome
- Dotenv
- bcrypt
Copyright 2021 COPYRIGHT David Lucio, Derek DeLizo, Simran Kaur, Jack Bentsen
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.