Gebru Lap 1 Project Team Penguins:

• Aafthab Ashraff
• Alfie Kelly
• Albert Stoykov
• Prishal Makwana

Released 01/04/2022 14:00, Sumbitted 08/04/2022 [XX:00]

[What does the application do]

• pengu.com is a community journaling website, where people can share and spred their love for penguins,
  as well as tackle topics related to climate change.

• Clone or download the repo
• cd into the Lap1Project/server folder in your terminal
• Run all dependencies
  • npm
  • nodemon
  • supertest
  • express
  • cors
  • jest

• cd to the server folder in your terminal & run npm start to launch the server
• Navigate to the client folder and open the index.html file in your browser to see the application UI

• HTML/CSS
• JavaScript
• Bootstrap 5
• REVIEW: - do we need to add the Giphy API here? and Font Awesome icons?

[How did you go about creating this project]

Agreed on our way of working

• Agreed on a single method of communication about this project (slack)
• Agreed on what branches we will work in and will only merge in main after communicating to the rest of the team via slack
• Agreed where our single point of truth for this application will be stored (Figma)
• Agreed a rough plan of how we intend the week to go

Understanding the problem

• Tried to understand the core need for the application and wrote this in a single sentence

Defining and refining

• Defined the core requirements of the application and added each requirement as tickets in a kanban board
• Went through each ticket as a team to ensure we are all aligned with the requirments and how we indend to tackle the ticket

Design planning

• Found a few examples of similar journalling websites and took full screenshots of them
• Using Figma, as a team we went through each of these example screenshots and discussed what we liked and disliked about thier design
• Then as a team we drew a LoFi wireframe of our application

Organising and planning

• Assigned a few tickets to each team memeber
• Planned regular catch up sessions each day (morning, afternoon, evening) to see how everyone is doing and if we need to re-align/re-distribute work

• Did all the planning and a big part of the front-end work on day one.
• Dividing up the team and allowing half of the team to focus on front-end and the other on back-end in for the first two days really helped creating the skeletons of the application
• Responsive Navbar with detailed Hamburger Menu
• GIPFY API working

• Search bar inside navbar refused to get centered.
• Giphy API

• Despite GIPFY API working, the individual gifs do not appear inside the gif search menu. (ERROR - SameSite attribute was not set or is invalid).

• Emoji reaction counter data will be stored on the server
• Users would be able to add images and videos to their post
• Emoji reactions for comments

• MIT Licence

Copyright 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.