Install NodeJS from the Downloads-Page or your package manager.
The following instructions are primarly for Linux. Instructions on MacOS or Windows may require other steps
sudo -iu postgres
initdb -D /var/lib/postgres/data
sudo systemctl start postgresql
noodle
createdb noodle
noodle
createuser noodle
psql -d noodle -c "CREATE USER noodle WITH PASSWORD 'noodle'; GRANT ALL ON ALL TABLES IN SCHEMA public TO noodle;"
For more information see the the Section Server Setup and Operation in the PostgreSQL-Documentation or the PostgreSQL-Entry in the Arch Linux-Wiki.
npm i
src/index.ts
and tests/integration/helper.ts
(Only needed if using a different database than describe above)npm start init
administrator
and the password administrator
npm start
npm run watch
npm run test
npm run test:e2e
npm run build
The output of the build process will be inside build/
The application can be run by using the package (recommend) or cloning and running/building this repository.
For more information about accquiring the package see the Package Repository
If using the application in production NODE_ENV=development
MUST NOT BE SET.
Not doing so will sign with the JWT with a hardcoded value and produce a huge security risk.
If the packages has been installed globally, use the following command
noodleBackend
If the packages has been installed in a local project, use the application with the following command
npx noodleBackend
This will compile the project and the execute it with node
, to improve performance
npm run start:prod
The API-Documentation can be found in the Wiki For the Module Documentation look here
Generated using TypeDoc