1
- <p align =" center " width =" 100% " >
2
- <img src="https://github.com/plutov/formulosity/blob/main/ui/public/logo_wide.png" height="100px">
3
- </p >
1
+ <img src =" https://github.com/plutov/formulosity/blob/main/ui/public/logo_wide.png " height =" 100px " >
4
2
5
- <p align =" center " >
6
- Formulosity is a self-hosted app for building and deploying the surveys using code instead of traditional survey builders.
7
- </p >
3
+ ## Formulosity - self-hosted Surveys as Code platform.
8
4
9
5
This approach offers a number of advantages, including:
10
6
@@ -14,9 +10,7 @@ This approach offers a number of advantages, including:
14
10
15
11
** Formulosity** uses human-readable declarative language [ YAML] ( https://en.wikipedia.org/wiki/YAML ) .
16
12
17
- <p align =" center " width =" 100% " >
18
- <img src="https://github.com/plutov/formulosity/blob/main/ui/public/questions.png" height="250px">
19
- </p >
13
+ <img src =" https://github.com/plutov/formulosity/blob/main/ui/public/questions.png " height =" 250px " >
20
14
21
15
## Features
22
16
@@ -38,13 +32,9 @@ This approach offers a number of advantages, including:
38
32
- [ ] Advanced question types
39
33
- [ ] Pipe answers into the following questions
40
34
41
- ## See it in Action!
42
-
43
- <p align =" center " width =" 100% " >
44
- <a href="https://formulosity.vercel.app/app">Admin Panel</a>
45
- </p >
35
+ ## Demo
46
36
47
- Note: use ` user ` / ` pass ` to login into the Console UI.
37
+ [ Demo admin panel ] ( https://formulosity.vercel.app/app ) . Credentials: ` user ` / ` pass `
48
38
49
39
## Survey Structure
50
40
@@ -64,7 +54,7 @@ surveys/
64
54
└── ...
65
55
```
66
56
67
- To get started, check out the ` ./surveys ` folder with multiple examples.
57
+ To get started, check out the ` ./api/ surveys ` folder with multiple examples.
68
58
69
59
## Survey Files
70
60
@@ -297,7 +287,7 @@ Where `{SURVEY_ID}` id the UUID of a given survey.
297
287
docker-compose up -d --build
298
288
```
299
289
300
- And you should be able to access the UI on http://localhost:3000 (default basic auth: `user:pass`).
290
+ And you should be able to access the UI on [localhost:3000]( http://localhost:3000) (default basic auth: `user:pass`).
301
291
302
292
You can deploy individual services to any cloud provider or self host them.
303
293
@@ -307,28 +297,14 @@ You can deploy individual services to any cloud provider or self host them.
307
297
308
298
The demo service (links above) is deployed to Fly.io (Go, SQLite) and Vercel (Next.js) and are under the free tiers.
309
299
310
- ### Backend Development setup
311
-
312
- Install AIR locally from [here](https://github.com/air-verse/air)
313
-
314
- Run the following command after AIR installation
315
-
316
- ```
317
- cd api
318
- air
319
- ```
320
-
321
- This command will help in live reloading whenever changes are done in the APIs using `air`.
322
- Custom configurations can be set by modifying `air.toml` file
323
-
324
300
### Environment Variables
325
301
326
302
API:
327
303
328
304
- `DATABASE_TYPE` - `sqlite` or `postgres`
329
305
- `DATABASE_URL` - Postgres or SQLite connection string
330
- - `LOG_LEVEL` - Log level, e.g. `info`
331
306
- `SURVEYS_DIR` - Directory with surveys, e.g. `/root/surveys`. It's suggested to use mounted volume for this directory.
307
+ - `UPLOADS_DIR` - Directory for uploading files from the survey forms.
332
308
333
309
UI:
334
310
0 commit comments