Gebru Lap 1 Project Team Penguins:

• Trina Yau
• Alfie Kelly
• Michael Harkins
• Dan Willis

Installation is not required as this app has been deployed. However, prior to deployement, installation instructions consisted of:

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

This current release of the project has our server-side running on Heroku and client-side running on netlify.

• Server - https://penguin-journa1s.herokuapp.com/
• Client - https://penguin-journals.netlify.app/

If you wish to run the application locally, please follow the following:

• Update client/index.js API to http://localhost:3000/journal and save
• 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 (Bootstrap)
• JavaScript
  • Node.js
  • Express
  • Cors
  • Jest
  • Supertest
  • ejs

[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

• MIT Licence

Copyright 2022