mirror of
https://github.com/thegeneralist01/archivr
synced 2026-01-09 14:40:25 +01:00
docs: add README and LICENSE
This commit is contained in:
parent
01cc7826bf
commit
553cca99ca
3 changed files with 74 additions and 0 deletions
1
.gitignore
vendored
1
.gitignore
vendored
|
|
@ -1,6 +1,7 @@
|
|||
*
|
||||
|
||||
!.gitignore
|
||||
!*.md
|
||||
|
||||
!src
|
||||
!src/**
|
||||
|
|
|
|||
21
LICENSE.md
Normal file
21
LICENSE.md
Normal file
|
|
@ -0,0 +1,21 @@
|
|||
# MIT License
|
||||
|
||||
Copyright (c) 2025-present thegeneralist01
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
52
README.md
Normal file
52
README.md
Normal file
|
|
@ -0,0 +1,52 @@
|
|||
# archivr
|
||||
|
||||
An open-source self-hosted archiving solution. Work in progress.
|
||||
|
||||
## Milestones
|
||||
- [ ] Archiving
|
||||
- [ ] Archiving media files from social media platforms
|
||||
- [ ] YouTube
|
||||
- [ ] Twitter
|
||||
- [ ] Instagram
|
||||
- [ ] Facebook
|
||||
- [ ] TikTok
|
||||
- [ ] Reddit
|
||||
- [ ] Snapchat
|
||||
- (Some of these could be postponed for later.)
|
||||
- [ ] Archiving local files
|
||||
- [ ] Archive videos (MP4, WebM)
|
||||
- [ ] Archive audio files (MP3, WAV)
|
||||
- [ ] Archive documents (DOCX, XLSX, PPTX)
|
||||
- [ ] Archive PDFs
|
||||
- [ ] Archive images (JPEG, PNG, GIF)
|
||||
- [ ] Archiving files from cloud storage services (Google Drive, Dropbox, OneDrive) and from URLs
|
||||
- [ ] URLs
|
||||
- [ ] Google Drive
|
||||
- [ ] Dropbox
|
||||
- [ ] OneDrive
|
||||
- [ ] Archive web pages (HTML, CSS, JS, images)
|
||||
- [ ] Archiving emails (???)
|
||||
- [ ] Gmail
|
||||
- [ ] Outlook
|
||||
- [ ] Yahoo Mail
|
||||
- [ ] Management
|
||||
- [ ] Deduplication
|
||||
- [ ] Tagging system
|
||||
- [ ] Search functionality
|
||||
- [ ] Categorization
|
||||
- [ ] Metadata extraction and storage
|
||||
- [ ] User Interface
|
||||
- [ ] Web-based UI
|
||||
- [ ] Backup and Sync
|
||||
- [ ] Cloud backup (AWS S3, Google Cloud Storage)
|
||||
- [ ] Local backup
|
||||
|
||||
## Motivation
|
||||
There are two driving factors behind this project:
|
||||
- In the age of information, all data is ephemeral. Social media platforms frequently delete content, and cloud storage services can become inaccessible and unreliable. Being able to archive important data is *very important* for preserving personal memories and digital history.
|
||||
- I will be creating a small encyclopedia for my future family and kids. Therefore, I want to make sure that all the information I gather is preserved and accessible for future reference.
|
||||
|
||||
This project aims to provide a reliable solution for archiving important data from various sources, ensuring that users can preserve their digital assets for the long term.
|
||||
|
||||
## License
|
||||
This project is licensed under the MIT License. See the [LICENSE](LICENSE.md) file for details.
|
||||
Loading…
Add table
Add a link
Reference in a new issue