PonyMirrors/poll.horse
1
0
Fork 0
mirror of https://github.com/Wolvan/poll.horse.git synced 2024-11-21 20:47:59 +01:00
Code Issues Projects Releases Packages Wiki Activity
Mirror of https://github.com/Wolvan/poll.horse
16 commits 8 branches 11 tags 355 KiB
TypeScript 49.7%
JavaScript 21%
HTML 17%
CSS 11.3%
Dockerfile 1%
Find a file
Wolvan 9fa3eabad1 Make frontend js-less 
The frontend should work without having JS enabled. JS will enhance the
experience but should under no circumstance be necessary.
To achieve this, the entire entry system has been turned into a form
that posts its values to a new backend path specifically made to take
form responses. Instead of returning an API response, it also redirects
the browser to either the voting page on successful creation or the
frontpage with a bunch of get parameters that are used to prefill the
form in a server-side rendering process.
An error parameter is also given but there is no way to display said
error for now.
2022-01-01 04:13:24 +01:00
.vscode Add debugging run script 2022-01-01 04:06:02 +01:00
frontend Make frontend js-less 2022-01-01 04:13:24 +01:00
src Make frontend js-less 2022-01-01 04:13:24 +01:00
test Initial commit 2021-12-28 21:11:19 +01:00
utils Initial commit 2021-12-28 21:11:19 +01:00
.editorconfig Initial commit 2021-12-28 21:11:19 +01:00
.eslintignore Initial commit 2021-12-28 21:11:19 +01:00
.eslintrc.json Initial commit 2021-12-28 21:11:19 +01:00
.gitignore Fix config loading of boolean values 2021-12-29 17:04:23 +01:00
.mocharc.json Initial commit 2021-12-28 21:11:19 +01:00
LICENSE Initial commit 2021-12-28 21:11:19 +01:00
package-lock.json First steps towards functional frontend 2021-12-29 18:21:22 +01:00
package.json Add debugging run script 2022-01-01 04:06:02 +01:00
README.md Add debugging run script 2022-01-01 04:06:02 +01:00
tsconfig.json Initial commit 2021-12-28 21:11:19 +01:00

README.md

Poll.horse

Simple polling service for public polls

With strawpoll being somewhat very broken I decided to implement my own. Let's go!

What is this

If you have never used strawpoll, in short this is a website to easily make small polls without a fuss.

Contributing

The core is written in TypeScript, a typed superset to Javascript and executed with NodeJS. Pull Requests welcome.

Before cloning this repository, make sure you have Node installed.

Then clone this repository, open a terminal/command prompt and type npm i to install the required dependencies.

ts-node is recommended to test during development, install it with npm i -g ts-node typescript.

Directory Structure

  • ./dist - The finalized and compiled files that can be used with node
  • ./src - The source files of the project
  • ./test - Files required for unit testing, aka test setup/teardown and test spec files
  • ./utils - Various utility scripts not part of the main source code

Scripts

Execute the scripts with npm run <script>

  • find-todo - Finds remaining TODO: in the code and warns the developer that there are still things that are unfinished
  • mocha - Runs the unit tests in the /test directory
  • lint - Runs eslint and checks for code styling problems
  • build - Compile the TypeScript Source to dist/
  • test - Runs lint, find-todo and mocha in order
  • debug - Start the ./src/main.ts with node and start the debugger on port 9229
  • start - Run test and build, then try and execute the ./dist/main.js in the ./dist directory to test