joanwanjiku/marvel-comics

This is a group project that has been created for lovers of fictional stories and lovers of comics stories. The website provides users with detailed information on their favourite superheroes.

Marvel-comics.

This project was generated with Python version 3.7.8

Contributors

• By Joan Wanjiku https://github.com/joanwanjiku
• By Kingsley Muturi https://github.com/Kingsleymuturi
• By Bryson Mundia https://github.com/Bryson69
• By Albert Obwoge

Description

• This is a group project that has been created for lovers of fictional stories and lovers of comics stories. The website provides users with detailed information on their favourite superheroes. Information on how they got their powers ,biography connection and images are provided. The website also provides a list trending articles about the fictional world. The website is a great source of leisure as it provides a blog page where one can comment on certain characters.

Live-Link

• You can view the project on your browser using this Livelink

BDD

1. On loading the website displays a landing page that contains slides that have images of Marvel characters.

2. In order for the User to view the articles first you need to register upon registering you will be redirected to the login page whereby you will be needed to login for you can access any information.

3. The User is directed to the characters page via the character link on the navbar.On this page multiple characters will display and via the view button you can read the article about that specific character.

4. On the Navigation bar there is a "Comics" button.

   • input: the user clicks it to navigate to the page
   • Output:The page contains a list of comics that are trending about superheroes and interesting facts about them.

Set Up Instructions

• Open your terminal and move to a directory where you would like to store the project eg. cd Documents
• Use the command git clone to clone the application at d.
• After cloning navigate to the project.
• Run pip install to install all the dependencies
• Now run the project using your terminal with the command python3.6 manage.py or ./start.sh

Known Bugs

There are no known bugs yet.

Development

Want to contribute? Great!

To fix a bug or enhance an existing module, follow these steps:

• Fork the repo
• Create a new branch (git checkout -b improve-feature)
• Make the appropriate changes in the files
• Add changes to reflect the changes made
• Commit your changes (git commit -m 'Improve feature')
• Push to the branch (git push origin improve-feature)
• Create a Pull Request

Technologies Used

• PYTHON
• PIP
• FLASK FRAMEWORK
• MDBOOTSTRAP
• CSS
• POSTGRESS

Licence

The MIT License (MIT) Copyright (c) 2020 marvel-comics.

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.