194 lines
5.3 KiB
Markdown
194 lines
5.3 KiB
Markdown
|
|
# Table of Contents
|
|
|
|
1. [dev.metalisp.survey](#orgd64e9c8)
|
|
1. [Introduction](#orgf97d78a)
|
|
2. [Design Goals](#org6fd0952)
|
|
3. [Dependencies](#org81ce433)
|
|
4. [Mailing list](#org0d7fc51)
|
|
5. [Issue tracker](#org32aff05)
|
|
6. [News Feed](#orge459190)
|
|
7. [Installation instructions](#org50fe2e7)
|
|
1. [1. Install a Common Lisp implementation](#org8f3be53)
|
|
2. [2. Set up ASDF](#org5793033)
|
|
3. [3. Organize the project directory](#orgdc541ad)
|
|
4. [4. Configure ASDF to find the project](#org1137230)
|
|
5. [5. Load the project](#orgdf9fae7)
|
|
6. [6. Run the project](#orgdc968c0)
|
|
7. [Optional: Example Initialization in .sbclrc](#org98d9f63)
|
|
8. [License](#org3e92933)
|
|
|
|
|
|
|
|
<a id="orgd64e9c8"></a>
|
|
|
|
# dev.metalisp.survey
|
|
|
|
|
|
<a id="orgf97d78a"></a>
|
|
|
|
## Introduction
|
|
|
|
I am developing a web application using Common Lisp, designed to administer the
|
|
System Usability Scale (SUS) questionnaire efficiently. This application
|
|
simplifies the process of conducting usability evaluations by presenting SUS
|
|
questions and collecting responses, streamlining both the gathering and
|
|
analysis of usability feedback.
|
|
|
|
The software focuses on enhancing the ease of creating, managing, and
|
|
integrating questionnaires within existing websites or software. Leveraging
|
|
flexible templates, it offers a high level of reusability and
|
|
adaptability. Data from multiple questionnaires can be synthesized within a
|
|
single study, facilitating more profound insights. As a self-hosted solution,
|
|
it assures enhanced data protection, granting users complete control over their
|
|
data, a crucial feature for sensitive data environments. This application is
|
|
aimed at significantly contributing to research projects, market research, and
|
|
other fields where precise data collection and analysis are vital.
|
|
|
|
|
|
<a id="org6fd0952"></a>
|
|
|
|
## Design Goals
|
|
|
|
1. **Integration**: The app integrates seamlessly into existing digital
|
|
platforms, enhancing user experience and simplifying data capture.
|
|
|
|
2. **Reusability and Adaptability**: Customizable templates allow for the
|
|
creation of consistent and repeatable survey formats suitable for various
|
|
applications.
|
|
|
|
3. **Data Synthesis**: It supports combining data from multiple questionnaires
|
|
into a single study, providing broader and more comprehensive analytical
|
|
insights.
|
|
|
|
4. **Privacy and Control**: With self-hosting, the software ensures complete data
|
|
sovereignty and enhances privacy, avoiding the need to transfer sensitive
|
|
data to external servers.
|
|
|
|
|
|
<a id="org81ce433"></a>
|
|
|
|
## Dependencies
|
|
|
|
- <https://github.com/edicl/hunchentoot>
|
|
- <https://git.sr.ht/~marcuskammer/dev.metalisp.sbt>
|
|
|
|
|
|
<a id="org0d7fc51"></a>
|
|
|
|
## Mailing list
|
|
|
|
- <https://lists.sr.ht/~marcuskammer/dev.metalisp.survey>
|
|
|
|
|
|
<a id="org32aff05"></a>
|
|
|
|
## Issue tracker
|
|
|
|
- <https://todo.sr.ht/~marcuskammer/dev.metalisp.survey>
|
|
|
|
|
|
<a id="orge459190"></a>
|
|
|
|
## News Feed
|
|
|
|
- <https://git.sr.ht/~marcuskammer/dev.metalisp.survey/log/main/rss.xml>
|
|
|
|
|
|
<a id="org50fe2e7"></a>
|
|
|
|
## Installation instructions
|
|
|
|
|
|
<a id="org8f3be53"></a>
|
|
|
|
### 1. Install a Common Lisp implementation
|
|
|
|
- Ensure you have a Common Lisp implementation installed. Common options
|
|
include SBCL (Steel Bank Common Lisp) and CCL (Clozure Common Lisp). You
|
|
can download and install them from their respective websites:
|
|
- [SBCL](http://www.sbcl.org/)
|
|
- [CCL](https://ccl.clozure.com/)
|
|
|
|
|
|
<a id="org5793033"></a>
|
|
|
|
### 2. Set up ASDF
|
|
|
|
- ASDF is typically bundled with modern Lisp implementations. However, if
|
|
it’s not present, you can download it from [ASDF’s repository](https://gitlab.common-lisp.net/asdf/asdf).
|
|
|
|
|
|
<a id="orgdc541ad"></a>
|
|
|
|
### 3. Organize the project directory
|
|
|
|
- Place the `dev.metalisp.survey` project in the `~/common-lisp`
|
|
directory. Ensure the directory structure looks like this:
|
|
|
|
~/common-lisp/
|
|
└── dev.metalisp.survey/
|
|
├── dev.metalisp.survey.asd
|
|
└── src/
|
|
└── app.lisp
|
|
|
|
|
|
<a id="org1137230"></a>
|
|
|
|
### 4. Configure ASDF to find the project
|
|
|
|
- Open your Common Lisp REPL and run the following commands to set up the
|
|
ASDF central registry:
|
|
|
|
;; Ensure ASDF is loaded
|
|
(require :asdf)
|
|
|
|
;; Add ~/common-lisp to the ASDF central registry
|
|
(push #p"~/common-lisp/" asdf:*central-registry*)
|
|
|
|
|
|
<a id="orgdf9fae7"></a>
|
|
|
|
### 5. Load the project
|
|
|
|
- In your REPL, load the project by running:
|
|
|
|
(asdf:load-system :dev.metalisp.survey)
|
|
|
|
|
|
<a id="orgdc968c0"></a>
|
|
|
|
### 6. Run the project
|
|
|
|
- After loading the system, you can run the main function or entry point of
|
|
the project.
|
|
`ml-survey:start`, you would execute:
|
|
|
|
(ml-survey:start)
|
|
|
|
|
|
<a id="org98d9f63"></a>
|
|
|
|
### Optional: Example Initialization in .sbclrc
|
|
|
|
To make the ASDF configuration persistent across REPL sessions, you can add the
|
|
setup to your `.sbclrc` file:
|
|
|
|
1. Edit `.sbclrc`
|
|
- Open (or create) the `.sbclrc` file in your home directory and add the
|
|
following lines:
|
|
|
|
(require :asdf)
|
|
(push #p"~/common-lisp/" asdf:*central-registry*)
|
|
|
|
2. Reload SBCL
|
|
- The next time you start SBCL, it will automatically include the
|
|
`~/common-lisp` directory in the ASDF central registry.
|
|
|
|
|
|
<a id="org3e92933"></a>
|
|
|
|
## License
|
|
|
|
MIT
|
|
|