Letterpress.fi

A Finnish language Letterpress clone.

Requirements

• Leiningen for Development
• JVM for running it
• PostgreSQL

Environment variables

• DATABASE_URL – PostgreSQL URI, defaults to "postgres://postgres:secret@localhost:5432/letterpress"

Development mode

To start the Figwheel compiler, navigate to the project folder and run the following command in the terminal:

lein figwheel

Figwheel will automatically push cljs changes to the browser. The server will be available at http://localhost:3449 once Figwheel starts up.

Figwheel also starts nREPL using the value of the :nrepl-port in the :figwheel config found in project.clj. By default the port is set to 7002.

The figwheel server can have unexpected behaviors in some situations such as when using websockets. In this case it's recommended to run a standalone instance of a web server as follows:

lein do clean, run

The application will now be available at http://localhost:3000.

Style compilation

To compile sass sources and then watch for changes and recompile until interrupted, run

lein sass4clj auto

Optional development tools

Start the browser REPL:

$ lein repl

The Jetty server can be started by running:

(start-server)

and stopped by running:

(stop-server)

Starting the database

Postgresql

docker run -d -e POSTGRES_PASSWORD=secret --name letterpress-possu -p 5432:5432 postgres

Mongo

docker run -d -p 27017:27017 --name letterpress-mongo mongo

Building for release

lein do clean, uberjar

Deploying to Heroku

Make sure you have Git and Heroku toolbelt installed, then simply follow the steps below.

Optionally, test that your application runs locally with foreman by running.

foreman start

Now, you can initialize your git repo and commit your application.

git init
git add .
git commit -m "init"

create your app on Heroku

heroku create

The connection settings can be found at your Heroku dashboard under the add-ons for the app.

deploy the application

git push heroku master

Your application should now be deployed to Heroku! For further instructions see the official documentation.

Licenses

Letterpress.fi's source code is licensed with the MIT License, see LICENSE.txt

Varela Round font is obtained from Google Web Fonts and is licensed with SIL Open Font License, see OFL.txt.

Finnish word list is obtained from Kotimaisten kielten keskus and is licensed with GNU LGPL

Thanks

This project is a grateful recipient of the Futurice Open Source sponsorship program 🌶🦄.