Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shukerov/dataforme
A personal data analysis tool.
https://github.com/shukerov/dataforme
Last synced: 3 months ago
JSON representation
A personal data analysis tool.
- Host: GitHub
- URL: https://github.com/shukerov/dataforme
- Owner: shukerov
- License: gpl-3.0
- Created: 2019-09-18T22:13:48.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-12-11T07:21:21.000Z (about 2 years ago)
- Last Synced: 2024-08-01T21:55:06.154Z (6 months ago)
- Language: JavaScript
- Homepage: https://dataforme.xyz
- Size: 12.7 MB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 34
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- project-awesome - shukerov/dataforme - A personal data analysis tool. (JavaScript)
README
# Data For Me
*A tool for personal data analysis.*
The goal of this project is to provide a minimal framework for personal data analysis.
Personal data requests usually result in a zip file containing multiple JSON and media files.
This is an attempt to easily extract and analyze such zip files for the average user.
I am new to JavaScript and the open source community, so any help and mentorship would be greatly appreciated!
I hope this is useful to some of you.
Live link of the BETA website - https://dataforme.xyz.
## Table of Contents
- [Installation](#installation)
- [Usage](#usage)
- [Contributing](#contributing)
- [Credits](#credits)
## Installation
1. Make sure you have `nodejs` installed. Installation instructions [here](https://nodejs.org/en/download/).
2. Make sure you have `yarn` installed. Instructions [here](https://yarnpkg.com/lang/en/docs/install/#debian-stable).
3. Clone the repo - `git clone [email protected]:shukerov/dataforme.git`
4. Run `yarn install` to fetch all packages.
5. Run the dev server with:
```
yarn run dev // runs the regular development site
yarn run dev_looks // runs the development site with a preview (use this when working on styles)
```
6. Go to `localhost:8080` to view the website
# Usage
1. Click on one of the tiles to get started with a certain web service.
2. Read the instructions of how to request a copy of your data from the chosen web service.
3. Download your zip file and attach it to you browser in the filepicker area.
4. Read through you report.
# Contributing
Read the [wiki](https://github.com/shukerov/dataforme/wiki) on how to contribute, and add additional web services.
# Credits
DataForMe exists thanks to these open-source libraries:
* [`webpack`](https://webpack.js.org/) - an open-source module bundler for JavaScript files
* [`frappe-charts`](https://frappe.io/charts) - open-source svg graphing library
* [`zip.js`](https://gildas-lormeau.github.io/zip.js/) - open-source library for manipulating `zip` files in the browser
* [`lottie`](https://airbnb.io/lottie/#/) - airbnb animation library used just for nav (probably not needed...)
* [`feather-icons`](https://feathericons.com/) - simply beautiful open-source icons
A few icons come from [`fontawesome`](https://fontawesome.com). A link to their license can be found [https://fontawesome.com/license](here).