Skip to content

Commit

Permalink
make it oss
Browse files Browse the repository at this point in the history
  • Loading branch information
plutov committed Aug 6, 2024
0 parents commit 0b61915
Show file tree
Hide file tree
Showing 115 changed files with 12,407 additions and 0 deletions.
Binary file added .DS_Store
Binary file not shown.
17 changes: 17 additions & 0 deletions .github/workflows/test.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
name: Tests
on: [push]
jobs:
test:
name: Tests
runs-on: ubuntu-latest
steps:
- name: Install Go
uses: actions/setup-go@v5
with:
go-version: 1.22

- name: Check out code into the Go module directory
uses: actions/checkout@v4

- name: Run Tests
run: go test -v -bench=. -race ./...
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
pkg/github/tmp/
pkg/parser/tmp/
postgres-data/
21 changes: 21 additions & 0 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
FROM golang:1.22 as builder

WORKDIR /go/src/github.com/plutov/formulosity

COPY go.mod .
COPY go.sum .

RUN go mod download

COPY ./cmd ./cmd
COPY ./pkg ./pkg
COPY ./migrations ./migrations
RUN CGO_ENABLED=0 GOOS=linux go build -o api cmd/console-api/api.go

FROM alpine:latest
RUN apk --no-cache add ca-certificates tzdata bash
WORKDIR /root
COPY --from=builder /go/src/github.com/plutov/formulosity/api .
COPY --from=builder /go/src/github.com/plutov/formulosity/migrations ./migrations

CMD ["./api"]
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2024 Alex Pliutau

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.
11 changes: 11 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
lint:
golangci-lint run

test:
go test -v -bench=. -race ./...

gen: clean
mockery --all --recursive --dir ./pkg --case underscore --with-expecter

clean:
rm -rf mocks
266 changes: 266 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,266 @@
<p align="center" width="100%">
<img src="https://github.com/plutov/formulosity/blob/main/ui/public/logo_wide.png" height="100px">
</p>

<p align="center">
**Formulosity** is a self-hosted app for building and deploying the surveys using code instead of traditional survey builders.
</p>

This approach offers a number of advantages, including:

- **Version control**: Survey files can be stored in a Github repository, which makes it easy to track changes and collaborate with others.
- **Reproducibility**: Survey files can be easily shared and reproduced, making it easy to reuse surveys or create variations of existing surveys.
- **Automation**: Survey files can be used to automate the creation and deployment of surveys, which can save time and effort.

**Formulosity** uses human-readable declarative language [YAML](https://en.wikipedia.org/wiki/YAML).

<p align="center" width="100%">
<img src="https://github.com/plutov/formulosity/blob/main/ui/public/questions.png" height="250px">
</p>

## Features

- [x] Management API
- [x] Survey UI: for end users (respondents)
- [x] Console UI: manage surveys
- [x] YAML survey configuration
- [x] Basic question types
- [x] Default theme
- [ ] Custom themes support
- [x] Personalized options: intro, outro, etc.
- [x] Cookie/IP deduplication
- [ ] Detect survey changes in real time

## Survey Structure

Each directory in `SURVEYS_DIR` is a survey. You can configure the source of your surveys by setting different `SURVEYS_DIR` env var.

```bash
surveys/
├── survey1/
│ ├── metadata.yaml
│ ├── questions.yaml
│ ├── security.yaml
│ ├── variables.yaml
│ └── ...
└── survey2/
├── metadata.yaml
├── questions.yaml
└── ...
```

To get started, check out the `./surveys` folder with multiple examples.

## Survey Files

### metadata.yaml

This file is required! The file consists of a YAML object with specific properties describing the survey.

- **title**: This is the main title displayed to users at the beginning of the survey.
- **theme**: This specifies the visual theme applied to the survey. Currently supported themes are: default.
- **intro**: This text appears as an introduction before the first question.
- **outro**: This text appears as a conclusion after the last question.

```yaml
title: Survey Title
theme: default # or custom
intro: |
This is the introduction to the survey.
It can be multiple lines long.
outro: |
Thank you for taking the survey.
Your feedback is important to us.
```
### questions.yaml
This file is required! The file consists of a list of questions, each defined as a YAML object with specific properties.
- **type**: This specifies the type of question being asked.
- **id**: This provides a unique identifier for the question. It is useful for referencing specific questions in branching logic or data analysis. IDs must be unique across all questions in the survey.
- **label**: This is the text displayed to the user as the question itself.
- **description**: This provides additional information about the question for the user, such as clarification or instructions.
- **options**: This list defines the available answer choices for question types like `single-choice`, `multiple-choice` and `ranking`.
- **optionsFromVariable**: This property references a variable defined in a separate variables.yaml file. The variable should contain a list of options to be used for the question. This allows for reusability and centralized management of option lists.
- **validation**: This property is used to define validation rules for specific question types.

```yaml
questions:
- type: single-choice
id: question1 # optional ID, must be unique across all questions
label: What is the capital of Germany?
description: You can select multiple options
optionsFromVariable: german-city-options # defined in variables.yaml
options:
- Berlin
- Munich
- Paris
- London
- Hamburg
- Cologne
validation:
min: 1
max: 3
```

### security.yaml

This file is optional. The file consists of a YAML object with specific properties for survey security settings.

- **duplicateProtection**: This property defines how the platform handles duplicate responses from the same user.

```yaml
duplicateProtection: cookie # cookie | ip
```

### variables.yaml

This file is optional. The file consists of a list of variables, each defined as a YAML object with specific properties.

- **id**: This unique identifier references the variable within questions. IDs must be unique across all variables defined in the file.
- **type**: This specifies the type of data stored in the variable. Currently supported types are: list.

```yaml
variables:
- id: german-city-options # must be unique
type: list
options:
- Berlin
- Munich
- Hamburg
- Cologne
```

## Question Types

### Short Text

Prompts users for a brief written answer.

```yaml
- type: short-text
label: What is the capital of Germany?
```

### Long Text

Prompts users for a detailed written answer.

```yaml
- type: long-text
label: What is the capital of Germany?
```

### Single Choice

Presents a question with only one correct answer from a list of options.

```yaml
- type: single-choice
label: What is the capital of Germany?
options:
- Berlin
- Munich
- Paris
- London
- Hamburg
- Cologne
```

### Multiple Choice

Presents a question where users can select multiple answers (with limitations). You can customize the minimum and maximum allowed selections in the validation section.

```yaml
- type: multiple-choice
label: Which of the following are cities in Germany?
description: You can select multiple options
validation:
min: 1
max: 3
options:
- Berlin
- Munich
- Paris
- London
- Hamburg
- Cologne
```

### Date

Asks users to enter a specific date.

```yaml
- type: date
label: When was the Berlin Wall built?
```

### Rating

Presents a scale for users to rate something on a predefined range.

```yaml
- type: rating
label: How much do you like Berlin?
min: 1
max: 5
```

### Ranking

Asks users to rank options based on a given criteria.

```yaml
- type: ranking
label: Rank the following cities by population
optionsFromVariable: german-city-options
```

### Yes/No

Presents a question where users can only answer "yes" or "no".

```yaml
- type: yes-no
label: Is Berlin the capital of Germany?
```

## Screenshots

<p align="center" width="100%">
<img src="https://github.com/plutov/formulosity/blob/main/screenshots/app.png" hspace="10" height="200px">
<img src="https://github.com/plutov/formulosity/blob/main/screenshots/survey.png" hspace="10" height="200px">
</p>

## Installation: Docker

```
docker-compose up -d --build
```
And you should be able to access the UI on http://localhost:3000
## Tech Stack
- Backend: Go, Postgres
- UI: Next.js, Tailwind CSS
## Create new Postgres migration
Make sure to install [go-migrate](https://github.com/golang-migrate/migrate) first.
```
migrate create -dir migrations/postgres -ext sql -seq name
```
## Run Go tests
```
make test
```
## Contributing Guidelines
Pull requests, bug reports, and all other forms of contribution are welcomed and highly encouraged!
40 changes: 40 additions & 0 deletions cmd/console-api/api.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
package main

import (
"fmt"
"os"

controllers "github.com/plutov/formulosity/pkg/controllers"
"github.com/plutov/formulosity/pkg/log"
"github.com/plutov/formulosity/pkg/services"
"github.com/plutov/formulosity/pkg/surveys"
)

func main() {
log.Named("console-api")
logLevel := "info"
if os.Getenv("LOG_LEVEL") != "" {
logLevel = os.Getenv("LOG_LEVEL")
}
log.SetLogLevel(logLevel)

svc, err := services.InitServices()
if err != nil {
log.WithError(err).Fatal("unable to init dependencies")
}

if err := surveys.SyncSurveys(svc); err != nil {
log.WithError(err).Fatal("unable to sync surveys")
}

handler := controllers.NewHandler(svc)
if err != nil {
log.WithError(err).Fatal("unable to start server")
}

r := controllers.NewRouter(handler)

if err := r.Start(fmt.Sprintf(":%s", os.Getenv("PORT"))); err != nil {
log.WithError(err).Fatal("shutting down the server")
}
}
Loading

0 comments on commit 0b61915

Please sign in to comment.