for-the-record

Privacy focused open source audio journal

About The Project

for-the-record is a client-side only audio journal built with privacy in mind.

Here's why:

• Client-side only
• Works offline
• Protected by password
• Encrypts your audio data

This application is still in development, thus some functionality and features are still missing.

This app shouldn't be used as a finalized product. With that said, feel free to check the app out on this link: https://for-the-record.netlify.app

Getting Started

Prerequisites

• npm & node

Installation

1. Clone the repo

   git clone https://github.com/camolezi/for-the-record.git

2. Install NPM packages

   npm install

Starting the App

1. Web

   npm start

2. Electron

   npm start
   npm run electron

3. Android

TODO - android capacitor app instructions

Testing

1. Jest Tests

   npm test

2. Cypress Tests

   npm start
   npm run cypress

   Open cypress

   npm start
   npm run cypress:open

3. Storybooks

   npm run storybook

Roadmap

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

Contributing

Feel free to open issues and pull requests

License

Distributed under the MIT License. See LICENSE for more information.

Contact

camolezi@usp.br

Built With

• Typescript
• React
• Redux
• Chakra-ui

Acknowledgements

• Cypress
• Testing Library
• Jest
• dexie
• purify-ts
• Framer motion