mirror of https://github.com/Wolvan/poll.horse.git synced 2024-11-22 04:58:00 +01:00

Wolvan 08cb0df5e5 Add debugging run script

With this script one can easily launch a debuggable instance of the
current source code and then use vscode's debugger to attach to it.

2022-01-01 04:06:02 +01:00

Poll.horse

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.

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.

./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

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