Your Story Matters (YSM)

A companion app for survivors of sexual assault.

Currently in active development

Support Us

YSM is created by Chayn a global volunteer network with over 400 volunteers from 15 countries. If you like what you see and you want to join our team of volunteers get in touch. Or you can donate; all proceeds go to improving YSM and building more tools and resources at ChaynHQ.

YSM Frontend

A NextJs VueJS app with PWA mode enabled and Jest unit testing.

Development

Prerequisites

• NodeJS v14+
• Yarn v1.21+

Install dependencies

yarn

Create .env.local file

Include the following environment variables in a .env.local file

• NEXT_PUBLIC_FIREBASE_PROJECT_ID
• NEXT_PUBLIC_FIREBASE_APP_ID
• NEXT_PUBLIC_FIREBASE_KEY
• NEXT_PUBLIC_FIREBASE_DOMAIN
• NEXT_PUBLIC_ROLLBAR_SERVER_TOKEN
• NEXT_PUBLIC_ROLLBAR_CLIENT_TOKEN
• NEXT_PUBLIC_ROLLBAR_ENV
• NEXT_PUBLIC_MAILCHIMP_API_KEY
• NEXT_PUBLIC_MAILCHIMP_SERVER_PREFIX
• NEXT_PUBLIC_MAILCHIMP_AUDIENCE_ID
• NEXT_PUBLIC_ENV

Run locally

Start the app in development mode (with hot-code reloading, error reporting, etc.):

yarn dev:url

Run unit tests

yarn test:unit

To have your unit tests running in the background as you change code:

yarn test:unit:watch

Formatting and linting

yarn lint

To lint and fix:

yarn lint:fix

Formatting and linting is provided by ESLint and Prettier (see the relevant configs for details).

Workspace settings for VSCode are included in this folder.

Build the app for production

yarn build