Memento started as an experiment on introspection - private note-taking for thoughts you may want to revisit in the future.
It's a work in progress, alpha experimental project. Features are likely to change
You can find a live version here. It's on Heroku running on free dynos, so you may need to wait while it wakes up.
The user name does not need to be an e-mail address, although that will facilitate password reset in the future. You can use whatever login you fancy, though.
Memento is a straightforward note taking application for thoughts you may want to revisit: ideas, quotes, things you may have believed at a time and want to re-evaluate later.
It supports full-text search through PostgreSQL's own functions. It currently assumes that the language is English.
Memento was meant as a place to record what I was thinking at a specific time, so it has some editing rules:
- You can edit or delete thoughts for 24 hours after you've registered them;
- After that, a thought is "closed" and you can no longer modify it.
I set these in place to allow editing while avoiding second-guessing myself in the long run.
If at any point in the future you consider a thought to no longer be relevant, you can then just archive it. This will remove it from the default searches while keeping it still available, as well as keeping it inside any trains of thought you had recorded.
Memento allows you to set reminders for thoughts, so you can re-evaluate them later. Currently the only reminder type is spaced repetition on pre-set intervals.
You will need Leiningen 2.0 or above installed.
You'll need also need a PostgreSQL 9.4.4 database running. The default configuration assumes it's on localhost.
The repository provides dev-config.default.edn and test-config.default.edn on the resources folder. Copy them to the root and rename them to dev-config.edn and test-config.edn if you want to use the default settings.
Let's use the provided script to set up the database:
psql -d postgres < db-setup.sqlThis will create test and development databases, add the necessary extensions, and create a test user.
Then run the migrations on both dev and test with:
lein run migrate
lein with-profile test run migrateMemento uses token authentication. The tokens are signed using a private key, which is expected to be configured in the environment.
The repository includes a private/public key pair for development purposes. When deploying on your own instance, you'll need to replace prod_auth_pub_key.pem with the one matching your private key. The keys are currently configured on config.edn for the production environment, replacing it as an environment variable string should be enough.
To start a web server for the application, run:
lein run
It'll run on port 3000. You'll need to have compiled ClojureScript first.
Running lein test will run the tests against the memento_test database on the local host.
If you're using Cursive Clojure, bear in mind it does not yet support a way to launch a REPL with specific environment profile. Since the application reads its database connection parameters from the environment configuration, if you start a REPL from Cursive and run the tests against it, you'll be running them against the development database and not the test one.
Make sure you either create a REPL profile specifically for the test settings, or just run the tests via lein.
Copyright © 2015-2017 Numergent Limited. Released under the MIT License.