Identity is an open-source application that helps you save your most relevant memories.
Go to file
2024-06-30 22:05:46 +02:00
asset-api final linting 2024-06-30 22:05:46 +02:00
docs typos 2 2024-06-29 21:05:08 +02:00
identity-api final linting 2024-06-30 22:05:46 +02:00
identity-web final linting 2024-06-30 22:05:46 +02:00
.gitignore start implementing asset-api and m2m comms with identity-api 2024-06-16 12:18:19 +02:00
README.md Update README.md 2024-06-30 18:36:58 +00:00
SECURITY.md security.md 2024-06-29 21:19:38 +02:00

identity

Identity is an open-source application that helps you save your most meaningful memories.

Note: This is not a production-ready project by any means. There are still many things to be done.

Rationale

Identity is a project that initially started as an app whose purpose was to store music you like (or used to like) for future use in treatment for conditions such as dementia. Over time, the idea evolved and is now a general-purpose memory-saving app.

Projects

  • identity-web. The web app that interacts with the Identiy API and the Asset API.
  • identity-api. The Identity API, takes care of storing user data.
  • asset-api. The Asset API, takes care of storing user-generated assets.

Installation and building

The Identity project is composed by a web-app and two servers. In the future, Docker containers may be built to ease the installation of this project.

The recommended Node.JS version is v21.5.0, others should also work.

Development and local testing

identity-web

  1. Copy the .env.example file: cp .env.example .env
  2. Run yarn to install the dependencies.
  3. Run yarn dev and open the specified URL.
  4. You're ready to go! Any changes should be reflected in real time.

identity-api

  1. Copy the .env.example file: cp .env.example .env
  2. Run yarn to install the dependencies.
  3. Run yarn start to start the server.
    • Note: The asset-api server must be running before this command is run. More info.
    • You may need to create an empty folder at $/identity-api/.database.
  4. You're ready to go! You will need to restart the server manually when you make changed (unless you use something like Nodemon).

asset-api

  1. Copy the .env.example file: cp .env.example .env
  2. Run yarn to install the dependencies.
  3. Run yarn start to start the server.
    • You may need to create an empty folder at $/asset-api/.keys.
  4. You're ready to go! You will need to restart the server manually when you make changed (unless you use something like Nodemon).

Building and running

Note: Identity is not stable nor secure. Production instances are highly discouraged.

Building identity-web

  1. Copy and update the env.example file: cp .env.example .env
  2. Run yarn to install the dependencies.
  3. Run yarn preview to check that everything works properly.
  4. Modify the svelte.config.js file to deploy to your desired environment.
  5. Run yarn build to generate the SPA build.
    • The build will be placed at the build/ folder.

Contributing

Identity is free, open-source software licensed under AGPL-3.0 and MPL-2.0.

There are two methods to report bugs, submit patches, etc.

  1. Requesting an account. Send an e-mail to sofi@sofiaritz.com or send a Matrix PM to @sofiaritz:matrix.org and she will make an account on your behalf that you can use to create issues and submit patches through pull requests.
  2. E-mail or Matrix. You can send an e-mail to sofi@sofiaritz.com or send a Matrix PM to @sofiaritz:matrix.org with suggestions, bug reports, patches, etc. You can submit patches via e-mail thanks to git-send-email.

Choose the method you prefer, for frequent contributors it is recommended to request an account.

License

Citations

  1. Van de Winckel, A., Feys, H., De Weerdt, W., & Dom, R. (2004). Cognitive and behavioural effects of music-based exercises in patients with dementia. Clinical Rehabilitation, 18(3), 253-260. https://doi.org/10.1191/0269215504cr750oa
  2. The dementia guide: Living well after your diagnosis. (2021, April 16). Alzheimers Society. https://www.alzheimers.org.uk/get-support/publications-factsheets/the-dementia-guide