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

https://github.com/codellyson/localstorage-viewer


https://github.com/codellyson/localstorage-viewer

Last synced: 9 months ago
JSON representation

Awesome Lists containing this project

README

          

# LocalStorage Viewer Chrome Extension

A powerful and user-friendly Chrome extension that allows you to view, inspect, and monitor localStorage contents of any webpage in real-time.

## Features

- 🔍 View all localStorage items in a clean, organized interface
- 🎨 Beautiful dark/light theme support
- 🔄 Auto-refresh capability to monitor changes
- 📋 Easy copy functionality for values
- 🌳 Tree view for JSON data
- 🔐 Secure access to localStorage data
- 📱 Responsive design
- 🎯 Side panel support for easy access

## Installation

### From Chrome Web Store
1. Visit the [Chrome Web Store page](#) (coming soon)
2. Click "Add to Chrome"
3. Follow the prompts to install

### From Source
1. Clone this repository:
```bash
git clone https://github.com/yourusername/localstorage-viewer.git
```
2. Install dependencies:
```bash
npm install
```
3. Build the extension:
```bash
npm run build
```
4. Open Chrome and navigate to `chrome://extensions/`
5. Enable "Developer mode" in the top right
6. Click "Load unpacked" and select the `dist` directory

## Development

### Prerequisites
- Node.js >= 16.0.0
- npm >= 7.0.0

### Setup
1. Clone the repository
2. Install dependencies:
```bash
npm install
```

### Available Scripts
- `npm run dev` - Start development mode with hot reload
- `npm run build` - Build for production
- `npm run lint` - Run ESLint
- `npm run format` - Format code with Prettier
- `npm test` - Run tests
- `npm run package` - Create distribution package

### Project Structure
```
localstorage-viewer/
├── icons/ # Extension icons
├── dist/ # Built extension files
├── popup.html # Popup interface
├── popup.js # Popup logic
├── sidepanel.html # Side panel interface
├── sidepanel.js # Side panel logic
├── manifest.json # Extension manifest
└── package.json # Project configuration
```

## Security

- The extension only accesses localStorage data when explicitly requested
- No data is transmitted to external servers
- All operations are performed locally
- See [PRIVACY.md](./PRIVACY.md) for our privacy policy

## Contributing

1. Fork the repository
2. Create your feature branch: `git checkout -b feature/my-new-feature`
3. Commit your changes: `git commit -am 'Add some feature'`
4. Push to the branch: `git push origin feature/my-new-feature`
5. Submit a pull request

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

## Support

If you encounter any issues or have questions:
1. Check the [FAQ](./docs/FAQ.md)
2. Search existing [issues](https://github.com/yourusername/localstorage-viewer/issues)
3. Create a new issue if needed

## Acknowledgments

- Material Icons by Google
- Contributors and users of the extension