Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/isitraghav/reportit
University hackathon project, decentralized anonymous crime reporting app
https://github.com/isitraghav/reportit
decentralized framework7 gunjs javascript svelte
Last synced: 12 days ago
JSON representation
University hackathon project, decentralized anonymous crime reporting app
- Host: GitHub
- URL: https://github.com/isitraghav/reportit
- Owner: isitraghav
- Created: 2024-08-24T18:33:11.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-10-02T08:01:48.000Z (about 1 month ago)
- Last Synced: 2024-10-11T12:05:24.828Z (about 1 month ago)
- Topics: decentralized, framework7, gunjs, javascript, svelte
- Language: Svelte
- Homepage:
- Size: 3.35 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ReportIt
## Overview
**ReportIt** is a decentralized anonymous crime reporting app developed as part of a university hackathon. The application allows users to report crimes safely and anonymously, utilizing cutting-edge web technologies.
## Features
- **Decentralized Reporting**: Leverages decentralized technologies for secure and anonymous reporting.
- **Cross-Platform**: Built with Capacitor for seamless deployment on both web and Android.
## Tech Stack
- **Framework**: Svelte
- **Framework7**: For UI components and routing
- **Capacitor**: For mobile platform support
- **Gun.js**: For decentralized database
## Getting Started
### Prerequisites
- [Node.js](https://nodejs.org/) (>= 12.x)
- npm (comes with Node.js)
### Installation
1. Clone the repository:
```bash
git clone https://github.com/isitraghav/reportit.git
cd reportit
```
2. Install dependencies:
```bash
npm install
```
3. Add the Android platform for Capacitor:
```bash
npx cap add android
```
### Running the Application
To start the development server, use:
```bash
npm run dev
```
### Building for Production
To build the web app for production, run:
```bash
npm run build
```
### Building for Android
To build the app and copy it to the Android Capacitor project, run:
```bash
npm run build-capacitor-android
```
### Assets Management
- **Custom Icons & Splash Screens**: Replace images in the `assets-src` folder and generate new assets:
```bash
framework7 assets
```
or launch the UI:
```bash
framework7 assets --ui
```
- **Capacitor Assets**: Generate mobile app assets:
```bash
npx cordova-res
```
## Documentation & Resources
- [Framework7 Core Documentation](https://framework7.io/docs/)
- [Framework7 Svelte Documentation](https://framework7.io/svelte/)
- [Framework7 Icons Reference](https://framework7.io/icons/)
- [Capacitor Documentation](https://capacitorjs.com/docs)
## Contributing
Contributions are welcome! Please fork the repository and submit a pull request.
## License
This project is licensed under the MIT License.
## Acknowledgments
Special thanks to the Framework7 and Capacitor communities for their support and resources.
---