An open API service indexing awesome lists of open source software.

https://github.com/imevanc/linkage


https://github.com/imevanc/linkage

Last synced: 3 months ago
JSON representation

Awesome Lists containing this project

README

          

# LinkAge

## Table of contents

- [About ](#about-)
- [Tech Stack ](#tech-stack-)
- [Description ](#description-)
- [Setup ](#setup-)
- [Installation ](#installation-)

## About

LinkAge is An app aiming to helps connect isolated elderly individuals with volunteers, with the goal of
combating loneliness. The showcase presentation is available here -> [Team Reactors](https://northcoders.com/projects/april-2022/linkage)

## Tech Stack

- React
- Material UI
- MongoDB
- JWT
- Jest
- Express.js

The back end for this project can be found here: https://github.com/BitKoda/nc-group-project

## Description

`A hosted version` of this LinkAge app can be found at https://nc-project-age-ok.netlify.app/


LinkAge is responsive with a mobile first approach.

1. User first needs to sign up as a volunteer with an email, password and a postcode or directly login to their account.
2. The home page loads all the people available for a visit (visitees) on an interactive map. The green colour of the card means the person has been seen within the last 24 hours, Amber colour - within the last 48 hours and red - 72 hours and is in need to socialise.

3. User can click on any visitee card to see their profile info and submit a new visit

4. User can also see and modify their own profile info.

## Setup

You will need Node.js version 17.8.0 or higher and npm version 8.1.2 installed before being able to run this project.

## Installation

To run this project you will need to clone this repository onto your local machine.

```
$ git clone https://github.com/imevanc/nc-project-phase-fronted-ageuk.git
```

Navigate inside the folder and install all dependencies by entering the following commands on your terminal window:

```
$ cd nc-project-phase-fronted-ageuk
$ npm install
```

To run the application locally enter:

```
$ npm start
```

The application will run on http://localhost:3000.