Skip to content

Latest commit

 

History

History
57 lines (42 loc) · 2.31 KB

README.md

File metadata and controls

57 lines (42 loc) · 2.31 KB

Hellomouse Apps

🚧 This is currently under construction, features may change at any time 🚧

Preview

Hellomouse Apps is an app suite for Hellomouse. Currently we have the following apps:

  • Board: A pinterest / notes app for archiving websites, images, or just your own ideas, under /board.
    • Create boards and pins and share them with other users / the public
    • Create pins with text formatting, checklists, images, or link previews
    • Archive websites with a single click (save as HTML, PDF, special handling for some sites)
  • Link: A linktree clone with style support for hundreds of sites
  • Docs: Documentation for the app suite API under /docs
  • Site: Dashboard to view site archive tasks
  • Music: Music player with auto-download support for sites like Youtube, Bilibili, Soundcloud, etc...

Other Components

These will also need to be installed for the app to function.

Built With

  • https://img.shields.io/badge/nuxt.js-41b883?style=for-the-badge&logo=nuxtdotjs&logoColor=white
  • https://img.shields.io/badge/vue.js-34495E?style=for-the-badge&logo=vuedotjs&logoColor=white
  • Postgres
  • Rust
  • actix-web

Running

Setup

npm install

Development Server

Start the development server on http://localhost:3000:

npm run dev

Production

Build the application for production and locally preview production build

npm run build
npm run preview

Check out the deployment documentation for more information.