Welcome to Arachne's documentation site! Here you will find everything you need to start using Arachne, as well as reference and API documentation.
What is Arachne?
Arachne is a web framework for Clojure. It aims to be more than a collection of libraries, and provide a coherent, extensible skeleton for rapid development of robust, industrial-scale web applications.
It intends to exhibit the following qualities:
- Modularity. Each aspect of Arachne's functionality is delivered as a separate module.
- Cohesion. Despite being highly modular, each module exposes clear integration points, allowing modules to build on eachother to deliver highly sophisticated composite behavior.
- Data-driven. Each Arachne application is, at heart, a database specifying what programmatic entities exist and how they are linked.
Arachne provides a basic command-line project generator tool that you can use to create projects. To install this tool, simply download the shell script, place it somewhere on your system path (
~/bin is usually good), and
chmod it to be executable.
URL="https://raw.githubusercontent.com/arachne-framework/arachne-proj-gen/release/arachne.sh" curl $URL > ~/bin/arachne chmod +x ~/bin/arachne
Then, you can call it anywhere to create a new project, using the syntax
arachne new <project-name> <template>, where the project name is a fully qualified Clojure symbol, and the template is the Git URI of a template repository.
The namespace portion of the project name tells Arachne what kind of namespace structure to use for your project.
A good template to get started with is the
enterprise-spa, which sets up a robust single-page Arachne that uses Leiningen, Datomic, ClojureScript, Figwheel and Rum.
arachne new my.org/myapp email@example.com:arachne-framework/enterprise-spa.git
That's it! You've generated a project into a directory named
myapp. You can open up your favorite editor and start hacking, or run it right away:
cd myapp lein run :my.org/myapp :my.org.myapp/runtime
You'll see it compile some ClojureScript, and then you can try it out by hitting
http://localhost:8080 in your browser.
Note that the
enterprise-spa template includes support for SCSS/SASS out of the box; the system will fail to start unless you have the
sassc program installed and available on your path.
sassc is readily available via your system's package manager.
The above technique lets you get started quickily, but if you want to actually understand what's going on you'll probably want to try out the tutorials. These build a similar project, but break it down step by step and explain every concept as it appears.
- creating a new project
- handling HTTP requests
- using dependency injection
- using request interceptors
- serving static assets
- compiling ClojureScript
- dynamic ClojureScript development with Figwheel
See the overview for a high-level view of Arachne's architecture, and an explanation of how all the pieces fit together.
Arachne isn't a monolithic project; it is composed of many small modules, each designed to offer a vertically-integrated set of functionality.
All Arachne applications are built by assembling a selection of suitable modules, both from "official" modules and third-party modules. In fact, all Arachne projects are themselves modules and can be required by other Arachne projects.
Arachne's core modules include:
- arachne-core - boostrap Arachne itself
- arachne-http - definitions and tools for dealing with basic web concepts
- arachne-pedestal - a Pedestal-based HTTP server
- arachne-assets - generic asset transformation pipeline
- arachne-cljs - tools to compile ClojureScript (as part of an asset pipeline)
- arachne-figwheel - Figwheel server for rapid, iterative ClojureScript development
Visit these module's documentation pages for a detailed explanation of the concepts that they define, and how to use them in the context of a project.
Although we're still in an early alpha phase, contributions are welcome! Please see our Contributing Guide to see how you can get involved.