Skip to content

TuckerFaulk/Hackathon-Apr-23

Repository files navigation

CHARLIE CHARLIE ONE

amiresponsive mockup of the Charlie Charlie One Plattform

Link to the deployed site

Project Overview

Charlie Charlie One is a Peer Support Platform connecting veterans seeking mental health support with other veterans who have experienced similar challenges. To facilitate communication, support and encourage community engagement, Charlie Charlie One includes a matching system, a private messaging functionality, and group discussions (blog) and private and public profile options for those needing anonymity.

This platform was built using Django, Python, JavaScript and Bootstrap 4. The site was deployed on Heroku and uses Cloudinary for cloud storage.

Charlee Charlee One is Team 2's Stamp Out The Stigma project submission for Code Institute and Social Soda Hackathon (April 2023).

TABLE OF CONTENTS


USER EXPERIENCE

Strategy Plane

Project Goals

This section aims to make a positive difference in the mental health and well-being of veterans.

Our vision is to help veterans in their transition to getting back to life and working as any other civilian. As most of the veterans face too many questions about what to do and how life is after their’s serving, we aim to get them together by sharing their’s histories and finding others in similar situations – being able to express their feelings and challenges without being judged (for this reason, an anonymous user feature has been implemented).

Scope Plane

Feature Planning

When planning the Charlie Charlie One's features and scope, we drew up a Desirability, Importance and Viability analysis of all the features to be included in the project, and ranked each of these by order of importance from low (1) to high (5). The features that ranked the highest will be prioritised and delivered as part of the MVP. The target users for each ranked feature were also included.

# Feature Target User Desirability Importance Viability Delivered
USER ACCOUNTS
1 User Role Permissions All Users 1 5 5 5
2 Account Registration All Users 1 5 5 5
3 User Email Confirmation All Users 1 3 3 4
4 Password Reset All Users 1 5 5 5
5 Social Media Registration & Login All Visitors 5 2 2
NAVIGATION
6 Navigation to include: logo, my account (register, login) All Users 1 5 5 5
7 Navigation to include: my account (my profile, logout), bookmark Logged In Users 5 5 5
8 Top Navigation Search Bar All Users 1 2 3 5
9 Top Navigation to include: my account (my profile, logout) Logged In Superadmins 2 2 2
10 Searching All Logged In Users 1 5 5 5
11 Filtering All Logged In Users 1 5 5 5
BLOG
12 List of Posts All Users 1 5 5 5
13 Create Post All Logged In Users 1 5 5 5
14 Post Detail Page All Logged In Users 1 5 5 5
15 Comment on Post All Logged In Users 1 5 5 5
16 Like Posts All Logged In Users 1 5 5 5
PROFILES
17 User Profile Page Registered Users 5 5 5
18 User Public Profile Page Registered Users 5 5 5
19 Set Each User Info field to Private or Public All Registered Users 1 5 5 5
20 Follow Other Users All Logged In Users 1 5 5 5
21 Unfollow Other Users All Logged In Users 1 5 5 5
21 View List of Followed Users All Logged In Users 1 5 5 5
22 Update Personal Information All Logged In Users 1 5 5 5
23 Find a Veteran All Logged In Users 1 5 5 5
24 Filter List of Registered Veterans All Logged In Users 1 5 5 5
ONE TO ONE MESSAGING
25 Send Message to a User + Maintain Anonymity, if Preferred Logged In Users 5 5 5
26 Read Message from a User Logged In Users 5 5 5
27 Reply to Message from a User + Maintain Anonymity, if Preferred Logged In Users 5 5 5
28 View List of Messages Received Logged In Users 5 5 5
RESOURCES
29 List of Charities and NGOs Supporting Veterans and Military Personnel All Users 5 5 5
Email Marketing
30 Email Subscription, Powered by MailChimp Registered Subscribers 3 3 3
Contact Us
31 Contact Form All Users 1 3 3 3

User Stories

First Time Visitor Goals - As a first time user who has not created an account, I want to be able to:

  • Immediately understand the main purpose and use of the platform, Charlie Charlie One, and intuitively understand how to use it
  • Search for specific Veterans based on certain criteria, filter list of registered Veterans or view all.
  • Register/ create a user account

Registered User Goals - As a registered user, I want to be able to:

  • Learn more about what I can do on the Charlie Charlie One Platform
  • Create, read, edit, and delete my personal information
  • Set which of my information I choose to display publicly
  • Upload or not upload my image

Structure Plane

Interaction Design

Database Design

Database ERD

  • ERD

This ER diagram captures the relationships between real-world entities. The entities are the data points of objects such as persons, places and things and together with their attributes, compose their domain, ie, their individual table. The cardinality (relationships) between these entities are then mapped and identified.

Data Modelling

As evidenced by the ERD discussed above, the data model type used for this project is the Relational Model.

Skeleton Plane

Wireframes

We made sure they met the user and owner group criteria. As a result were used as a design for the project.

home page


account page


feed page


messages page

Colour Palette

The app's colour scheme was devised using the colour palette generator, and it consists of 5 colours:

We were inspired by this colour scheme as it reinforces the friendly, fresh and optimistic branding that is important to the app's tone. It also has colours with appropriate contrast for legibility and accessibility.

color palete

Features

Charlie Charlie One provides:

  • Matching System through ---

  • Post Content - contribute to the discussion

  • Enables veterans to join the discussion, ask for help and support other users anonymously through:

    • an option to set their profile details to private, where the only publicly available information is a required preferred display name
  • Veterans to create a profile and choose which of their information they want to share publicly. , private messaging, and group discussions (blog) to facilitate communication and support.

  • Toast message

    • Display according to the user actions.
  • Hero Image

    • We chose a hero image that we felt conveys the topic of the website immediately and catches attention.
  • Navbar

  • nav var

    • Home: Brings the user to the home page

    • About Us: Overview of the team.

    • Post: All post from site users.

    • Resources: List of charities to support users.

    • Register: Opens the form to Register.

    • Login: Opens the option to signUp.

  • Histories & Testimonials

    • We decide to add testimonials for the veterans to share their histories.

testimonials

  • Footer footer
    • Facebook link: It takes the user to the facebook home page.
    • Instagram link: It takes the useer to the Instagram home page.
    • Linkedin: It takes the useer to the Linkedin home page.
    • Twitter It takes the useer to the Twitter home page.

Testing

Functional Testing

  • Upon opening the site link correctly: Homepage (start screen) should open - Tested, the site loads up.

  • From Homepage pressing on the nav links:

    • Home - takes the user to the Homepage * Tested works as intended.
    • About Us - list of all of the team.
    • Post - all post from site users.
    • Register - takes the user to a form to register - Tested works as intended.
    • Login - takes the user to a form to sign up- Tested works as intended.
  • From Post page pressing on the nav links

    • Post title - Takes the user to the post detail - tested works as intended.
  • From Resources Page - xxx

    • Resource page - relevant links in different sections takes the user to external resources.

Technologies Used

Languages Used

  • HTML5 Used for the content and structure of the site.
  • CSS3 Used for the styling of the site.
  • Python Used for the back end programming of the site.

Frameworks Used

  • DJANGO - v3.2 Django is a free and open-source, Python-based web framework that follows the model–template–views architectural pattern.

  • Bootstrap4 - v4.6 was used as the frontend framework.

Programmes and Applications

  • Git used for version control and saving work in the repository, using the GitPod extension in Google Chrome to commit to GitHub.
  • GitHub is the project's git repository
  • GitBash Terminal used to push changes to the GitHub repository.
  • GitHub Projects used to track and integrate issues for Agile Development
  • favicon.io used to create the site's favicon
  • Chrome DevTools - used for debugging, validation (Lighthouse) and taking fullscreen screenshots of the site
  • Balsamiq - Used to create wireframes.
  • Heroku Used for hosting and deployment of the live site. Throughout, we have ensured the version being deployed to Heroku matches the development version by checking features and screen layouts on both versions.
  • VSCode - Used to create and edit the website.
  • Google Chrome DevTools - Used to test responsiveness and debug.
  • Cloudinary - Used to add images in the cloud.

Acknowledgments

Thank you to the Code Institute Hackathon Team and SODA who organised this Hackathon.

The Team


About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published