marcuskammer/dev.metalisp.survey
1
0
Fork 0
Code Issues 9 Pull requests Projects Releases Packages Wiki Activity Actions
No description
313 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 146db5116f
Add geometric mean
2024-08-29 08:19:46 +02:00
public Add print.css 2024-07-23 18:05:35 +02:00
src Add geometric mean 2024-08-29 08:19:46 +02:00
.gitignore Add gitignore 2024-06-27 17:55:01 +02:00
cloudinit.yml Update sbcl to version 2.4.7 2024-08-29 08:15:35 +02:00
create-core-with-swank.lisp Split create core 2024-06-16 15:11:26 +02:00
create-core.lisp Fix function naming 2024-07-09 21:47:16 +02:00
dev.metalisp.survey.asd Add geometric mean 2024-08-29 08:19:46 +02:00
Dockerfile Add example dockerfile 2024-06-01 10:55:35 +02:00
LICENSE Update README and LICENSE 2024-07-06 13:46:23 +02:00
main.tf Better naming for tf 2024-07-08 17:52:37 +02:00
providers.tf Update terraform 2024-06-27 17:55:21 +02:00
README.md Fix XMPP link 2024-07-12 17:13:35 +02:00
README.org Fix XMPP link 2024-07-12 17:13:35 +02:00
run-server.lisp Check if slime exists 2024-07-02 17:39:39 +02:00
run-server.sh Add bash line 2024-06-12 23:19:05 +02:00
screenshot.png Update screenshot 2024-07-06 14:14:52 +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. Disclaimer
    2. Introduction
    3. Design Goals
    4. Features
    5. Dependencies
    6. Mailing list
    7. Issue tracker
    8. News Feed
    9. XMPP Chat
    10. Installation instructions
      1. With using Quicklisp
    11. Screenshot
    12. License
      1. MIT

dev.metalisp.survey

Made with Love ❤️ and Common Lisp

Disclaimer

Libre software (LS) is often misunderstood as entirely free, including support and maintenance. While LS is freely available to use, modify, and distribute, users bear the responsibility for its integration, upkeep, and troubleshooting. Unlike commercial software, which typically includes support services, LS relies on community or paid third-party support, if available. This model empowers users with flexibility and control but requires a commitment to managing the software effectively. Therefore, adopting LS demands a proactive approach to handling any issues and ensuring the software meets organizational needs.

Introduction

I am developing a web application using Common Lisp, specifically tailored for efficiently administering the

to streamline usability evaluations. This application not only presents these various questions and collects responses but also simplifies the entire process of gathering and analyzing usability feedback. Designed to enhance the ease of creating, managing, and integrating questionnaires within existing websites or software systems, it leverages flexible templates to offer high levels of reusability and adaptability. The software allows for the synthesis of data from multiple questionnaires into a single study, enabling deeper insights. As a self-hosted solution, it provides enhanced data protection, granting users full control over their data—a crucial feature in environments handling sensitive data. This makes it an invaluable tool for research projects, market research, and other sectors that require precise data collection and analysis.

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

XMPP Chat

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)

Screenshot

img

License

MIT

Copyright (c) 2024 Marcus Kammer

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.