GithubHelp home page GithubHelp logo

rebecacalvoquintero / allaboutme Goto Github PK

View Code? Open in Web Editor NEW

This project forked from fac-11/allaboutme

0.0 1.0 0.0 4.16 MB

An app to help young people at Anna Freud centre to easily transition to adult care

Home Page: https://allaboutme-annafreud.herokuapp.com/

JavaScript 41.01% CSS 3.70% HTML 48.82% PLpgSQL 6.47%

allaboutme's Introduction

All About Me ๐Ÿ’ช Build Status codecov

25.9.17 - 13.10.17 | Founders & Coders Student Project

Made by Constantina, Dak, Jen & Rebeca :octocat:

sign in page

Summary ๐Ÿ“

All About Me is a mobile-first web application which allows young people at the Anna Freud centre to answer questions about their mental health and send their answers to their mental heath workers.

Or as we say in the app:
welcome page

Challenge โš ๏ธ

Patients at The Anna Freud Centre were tired of being asked the same questions every time their clinician changed or when they went to a new centre. They wrote up the most commonly asked questions into one questionnaire which they could give to their clinicians, however it was still paper-based.

Solution ๐Ÿ’ก

All About Me allows patients to answer the questionnaire online in their own time, save their answers, and update their details as needed. When they're ready they can send their form to their clinician.

How?

Design Sprint ๐ŸŽจ (See a detailed process here)

  • Ideation

  • Prototyping

  • User Testing

The outcome of our design sprint was a functioning prototype designed in Figma:

figma designs

Build Sprint ๐Ÿ”ง

  • Sprint Planning

  • Technical spike

    • PWA
  • Build!

See the outcome of our build sprint below!

User Stories ๐Ÿ“š

In order to create a realistic MVP we focused on specific user stories we wanted to achieve.

"As a user I want to be able to...:"

  • Login securely
  • Sign up to the app
  • Select a personal colour - started, majority set as issue for spring 2
  • Answer the questionnaire
  • Send answers to questions
  • Edit answers once saved
  • See my progress within the questionnaire via a progress bar
  • See completed/incomplete sections on screen - sprint 2
  • Access the app offline - spring 2
  • Be able to use the form on mobile and desktop
  • See ideas to difficult questions
  • Enjoy using the app

The MVP! โœจ

Check it out here ๐Ÿ‘€

Or look at this short video that shows basic functionality of the app:

app walkthrough gif

Set up the app locally ๐Ÿ’ป

First clone this repo: git clone [email protected]:FAC-11/AllAboutMe.git

then run npm i to install the dependencies for the app.

Database Setup

In terminal type psql or pgcli if installed. Within psql/pcli enter the following commands:

CREATE DATABASE [db_name];  
CREATE USER [user_name] WITH PASSWORD ['password'];

Now you can set the database url in your config.env as follows (setting the values in square brackets to the values you defined in the steps above):

postgres://[user_name]:[password]@localhost:5432/[db_name]

Next run the db_build.js file in terminal:

node src/database/db_build.js

This will create the tables in your database.

Environment Variables

Environment variables are one of the ways we keep our product safe. If you want to access our app locally you will need to add your own.

First create a config.env file and add the following variables:

DATABASE_URL
SECRET
SESSION_SECRET

and for sending emails you need the following:

TEMPLATE_DIRECTORY
AWS_REGION
AWS_ACCESS_KEY_ID
AWS_SECRET_ACCESS_KEY

(Note: have a look at the SendEmail module to set this up and find the values for the variables)

Start the Server

You can now start the server! In your terminal write:

npm run devStart

then you should be able to go to localhost and view the app!

To be continued... ๐Ÿ˜Ž

In the next sprint, we aim to:

  • Make the app available when the user is offline (PWA)
  • Allow the user to change the colours of the whole app
  • Take into account the possible data storage constraints
  • Allow the user to draw his answers
  • Possible extra animation
  • Add 'Forgotten your password?' functionality
  • More tests to prevent errors from happening
  • Add typeform style
  • Styling error pages

Technologies ๐Ÿ’พ

Rescources

๐Ÿ’ƒ๐Ÿ’ƒ๐Ÿ’ƒ๐Ÿ’ƒ

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.