Skip to content

outlaw-dame/memory

 
 

Repository files navigation

Memory

A Microblog-App that saves all data on your Pod.

Built on the ActivityPods framework.

Running the app

  • Clone the repo git clone https://github.com/activitypods/memory.git
  • go into the directory cd memory
  • run make start-prod to start the app
  • open the browser at http://localhost:4000

Note that the app is currently only optimized for mobile devices. so to use it on a desktop browser, you need to use dev tools.

Currently optimised mobile devices are:

  • iPhone 11 Pro (375x812)

Development

Prerequisites

Running the app

  • Clone the repo git clone https://github.com/activitypods/memory.git
  • go into the directory cd memory
    • if you use VsCode or VsCodium, you can install the recommended extensions for development for a better development experience
  • run make start to start the PodProvider
  • run bun install to install prettier for code formatting (if there is a better way to do this, please let me know)

Running the api

  • go into the directory cd api
  • run bun install to install the dependencies
  • run bun dev to start the api

Running the frontend

  • go into the directory cd frontend
  • run bun install to install the dependencies
  • run bun dev to start the frontend

Building the app for android

Prerequisites

Running the app

  • make sure you are in the frontend directory
  • run bun install to install the dependencies
  • run bun sync to sync the ionic capacitor dependencies
  • run bun open:android to open the android project in android studio
    • for more information on how to run the app, check out the Capacitor Docs

Building the app for ios

Prerequisites

Running the app

  • make sure you are in the frontend directory
  • run bun install to install the dependencies
  • run bun sync to sync the ionic capacitor dependencies
  • run bun open:ios to open the ios project in xcode
    • for information on how to run the app, check out the Capacitor Docs (this is untested at the moment)

Commands

make start Starts the activitypods provider using a docker-compose file. This includes the activitypods backend, the fuskie db and a postgresql database for the api.

make stop Stops and removes all containers for the activitypods provider.

make config Prints the config with the .env-file-provided environment variables filled.

make logs-activitypods Prints the activitypods provider logs.

make attach-activitypods Attaches to the moleculer repl of the activitypods backend.

About

Mastodon-compatible app powered by ActivityPods

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 52.1%
  • Vue 21.4%
  • Swift 5.6%
  • CSS 4.9%
  • Makefile 3.7%
  • SCSS 3.6%
  • Other 8.7%