marcuskammer/dev.metalisp.survey
1
0
Fork 0
Code Issues 9 Pull requests Projects Releases Packages Wiki Activity Actions
No description
197 commits 1 branch 2 tags 1.2 MiB
Common Lisp 88.2%
HCL 6.5%
CSS 1.7%
Dockerfile 1.2%
Shell 1.1%
Other 1.3%
Find a file
Marcus Kammer f1143ecedf
Update README
2024-06-24 19:05:09 +02:00
public Add chartjs 2024-06-24 17:26:06 +02:00
src Eliminate create-survey resource 2024-06-24 18:21:03 +02:00
aws.tf Add example terraform file for aws 2024-06-20 20:26:24 +02:00
create-core-with-swank.lisp Split create core 2024-06-16 15:11:26 +02:00
create-core.lisp Split create core 2024-06-16 15:11:26 +02:00
dev.metalisp.survey.asd Remove non existing file from package loading 2024-06-24 18:22:30 +02:00
Dockerfile Add example dockerfile 2024-06-01 10:55:35 +02:00
LICENSE Add LICENSE information 2024-06-02 22:55:58 +02:00
README.md Update README 2024-06-24 19:05:09 +02:00
README.org Update README 2024-06-24 19:05:09 +02:00
run-server.lisp Load survey package 2024-06-21 17:23:31 +02:00
run-server.sh Add bash line 2024-06-12 23:19:05 +02:00
sbcl-nginx.yml Checkout emacs.d 2024-06-21 19:00:02 +02:00
setup.sh Focus on used libs 2024-06-12 23:20:32 +02:00

README.md

Table of Contents

  1. dev.metalisp.survey
    1. Introduction
    2. Design Goals
    3. Features
    4. Dependencies
    5. Mailing list
    6. Issue tracker
    7. News Feed
    8. Installation instructions
      1. With using Quicklisp
    9. License

dev.metalisp.survey

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.

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.

  5. Accessibility: The application is designed following the Web Content Accessibility Guidelines (WCAG) provided by WebAIM, ensuring that the survey is accessible to all users, including those with disabilities. This includes features such as keyboard navigation, screen reader compatibility, and high contrast modes to accommodate users with varying needs and abilities.

Features

  1. Questionnaires: Questionnaires can be defined using a Domain-Specific Language (DSL) developed for dev.metalisp.sbt. The benefit of defining forms in files is that they can be versioned using GIT, providing better control over changes and updates.

  2. Simplicity: All data is saved to files, eliminating the need for a database. This reduces costs for self-hosting and simplifies the setup and maintenance of the application.

Dependencies

Mailing list

Issue tracker

News Feed

Installation instructions

With using Quicklisp

Quicklisp is a highly recommended library manager for Common Lisp capable of streamlining the process of installing and maintaining libraries. It simplifies downloading, building, and loading libraries with a minimal fuss and supports command line interaction.

This guide will demonstrate how to install Quicklisp on both Linux and Windows operating systems.

  1. Why Use Quicklisp?

    Quicklisp offers several advantages for Common Lisp development:

    • Ease of Use: It simplifies the installation process of common Lisp libraries, handling dependencies automatically.
    • Extensive Library Collection: Quicklisp connects to a vast repository of libraries, making it easy to find and install almost any library you need for a project.
    • Regular Updates: Quicklisp updates its library list monthly, so you always have access to the latest versions.
    • Integration: It integrates well with many Lisp environments and tools, enhancing your development workflow.

  2. On Linux

    1. Install a Common Lisp implementation: For example, to install SBCL:

      sudo apt-get install sbcl

    2. Download Quicklisp Installer: Open a terminal and run:

      curl -O https://beta.quicklisp.org/quicklisp.lisp

    3. Install Quicklisp: With Lisp implementation installed (e.g., SBCL), run:

      sbcl --load quicklisp.lisp

      Within the Lisp environment, enter:

      (quicklisp-quickstart:install)

    4. Integrate Quicklisp with your Lisp environment: To automatically load Quicklisp on Lisp startup:

      (ql:add-to-init-file)

      Follow the on-screen instructions, then exit Lisp:

      (quit)

  3. On Windows

    1. Install a Common Lisp implementation: Download and install, for example, SBCL from http://www.sbcl.org/platform-table.html

    2. Download Quicklisp Installer: Open PowerShell and run:

      Invoke-WebRequest -Uri https://beta.quicklisp.org/quicklisp.lisp -OutFile quicklisp.lisp

    3. Install Quicklisp: Open installed Lisp (e.g., SBCL) shell by searching it in the start menu. Then run:

      --load quicklisp.lisp

      Within the Lisp REPL, execute:

      (quicklisp-quickstart:install)

    4. Set Up Quicklisp: To enable Quicklisp every time Lisp starts:

      (ql:add-to-init-file)

      Follow the steps provided, then exit:

      (quit)

  4. Load dev.metalisp.survey

    1. Clone this repository and dev.metalisp.sbt

      git clone git@git.sr.ht:~marcuskammer/dev.metalisp.sbt ~/quicklisp/local-projects/
git clone git@git.sr.ht:~marcuskammer/dev.metalisp.survey ~/quicklisp/local-projects/

    2. Start sbcl and load dev.metalisp.survey

      (ql:quickload :dev.metalisp.survey)

License

MIT