Getting Started
Last updated
Last updated
Welcome to ShipClojure! This guide will help you get your development environment set up and running quickly.
Install for managing development environment tools
Clone the ShipClojure repository and set up your own repository
See for more details on how to manage ShipClojure updates.
Set up the development environment using mise:
Install npm dependencies:
Set up development secrets:
Make sure to update the values in .dev-secrets.edn
with your development credentials, especially the database connection.
See for more details.
ShipClojure offers multiple ways to run the development environment:
The easiest way to get started is using Babashka scripts:
This will start the Shadow-CLJS development server (for the frontend) and the Clojure backend server.
NOTE: This workflow is not recommended. The frontend html is served from a template on the backend, that include only the necessary data and many pages are protected so won't be accessible without the backend running. This is very much a convenience hack and should be used sparingly.
To run the tests:
To create a production build:
Create .prod-secrets.edn
:
Update secret values to production ones
Run bb release
This will build optimized frontend assets and prepare the application for deployment.
NOTE: Changes on the backend server won't be reflected until the server is restarted. See for a more interactive workflow.
For a more interactive development experience, check out the documentation.
Explore the to learn more about the architecture and components
Check out the to understand the available UI building blocks
Learn about the