Skip to content

Latest commit

 

History

History
219 lines (168 loc) · 10.2 KB

README.md

File metadata and controls

219 lines (168 loc) · 10.2 KB
Raw


Logo

EasyBoard

A product to empower Persons with Intellectual Disabilities (PWIDs) navigate to
and from work and school with greater independence

Explore the docs »

View Figma Wires · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Roadmap
  4. Contributing
  5. Additional Links

About The Project

No solution comes with product first in mind. Here, we present our findings and thought processes that lead us to our solution.

  • Current products (e.g. Google Maps, Apple Maps):
    • Too complicated, typically cluttered with too many features
    • Offer too many options for routes
    • Do not tailor routes according to common challenges faced by PWIDs
    • Do not have step-by-step guides in commute
  • The app should provide clear and concise instructions, and use visual aids to supplement audio instructions.
  • The app should also have safety features built-in, such as the ability to share the user's location with their caregiver or call their caregiver in an emergency.
  • As each person is unique, the app should be developed in collaboration with neurodivergent individuals to ensure accessibility and usability.

(back to top)

Built With

React Expo Typescript Tailwind

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

To use Expo, you need to have the following tools installed on your machine:

  • Node.js LTS release - Only Node.js LTS releases (even-numbered) are recommended.

  • Git for source control.

  • Watchman (for Linux or macOS users).

  • npm

    npm install
expo start # or "npm run start"

  •  iOS

    • To run it there 2 methods, through simulator or IOS device.
    • To run iOS simulator, please download XCode first
      • Make sure you have command line tools active - See Thread
    • For more information, see -> How to run or debug iOS build

  • Android

    • TODO

Deployment

Read - How to Deploy

(back to top)

Roadmap

See - Easy Board 3.0 User story

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

Feel free to reach out to Richard or JR if you need any help, or would like to be added as an active member

(back to top)

Additional Links

Github Project Link: https://github.com/Engineering-Good/Easyboard3

Documentation & Tutorials

Source Link
From engineering good1 Notion Link
From engineering good2 Notion Link
From better sg Notion Link
Knowledge Transfer, Feb 2023 Video
Google-Routes API Reference Documentation (General)
Google-Routes API Reference Documentation - Compute Routes
(Tutorial) Online react course Udemy Course
(Tutorial) React Native getting started page React-Native Docs
(Tutorial) Official TypeScript Handbook Typescript Handbook
(Tutorial) Overview on using React with Typescript React + TypeScript Cheatsheet

(back to top)