1
0
Fork 0
forked from svrjs/svrjs
SVR.JS - a web server running on Node.JS
This repository has been archived on 2024-11-10. You can view files and clone it, but cannot push or open issues or pull requests.
Find a file
2024-08-31 11:48:14 +02:00
.github/workflows Update main.yml 2024-06-22 09:16:06 +02:00
assets Change SVR.JS logo 2024-08-26 13:46:57 +02:00
src Add tests for middleware, add ".js" file extensions inside the require functions in tests for utility functions, make error handling in URL rewriting middleware better, and lint out static file serving and directory listing middleware 2024-08-30 22:11:16 +02:00
templates Add unknown licenses, but display "Unknown" as a license type 2024-08-27 16:04:43 +02:00
tests Add tests for middleware, add ".js" file extensions inside the require functions in tests for utility functions, make error handling in URL rewriting middleware better, and lint out static file serving and directory listing middleware 2024-08-30 22:11:16 +02:00
utils Fix or ignore all ESLint errors 2024-08-27 11:28:24 +02:00
.gitignore Remove lockfiles from .gitignore 2024-08-30 22:21:56 +02:00
esbuild.config.js Make the build script also pack empty directories into zip file 2024-08-30 08:06:09 +02:00
eslint.config.js Change ESLint configuration to use CommonJS modules instead of ES modules. 2024-08-25 14:27:22 +02:00
jest.config.js Rewritten SVR.JS from scratch - the build system for the new SVR.JS is set up, but the source is just placeholders. 2024-08-23 17:05:10 +02:00
LICENSE Add LICENSE file 2024-08-26 08:00:04 +02:00
package-lock.json Update dependencies 2024-08-30 22:48:53 +02:00
package.json Add test coverage npm script and add "coverage" folder to .gitignore 2024-08-30 22:18:22 +02:00
README Update README 2024-08-31 11:48:14 +02:00
svrjs.json Make change log for specific SVR.JS version generated by the build script 2024-08-27 10:49:36 +02:00

This repository contains SVR.JS source code and its build system.

Before doing anything, run "npm install".
To build SVR.JS along with the zip archive, run "npm run build".
To check SVR.JS code for errors with ESLint, run "npm run lint".
To fix and beautify SVR.JS code with ESLint and Prettier, run "npm run lint:fix".
To run SVR.JS from the "dist" folder, run "npm start".
To test SVR.JS itself, run "npm run dev". This removes existing configuration.
To perform unit tests with Jest, run "npm test".

Structure:
 - assets - files to copy into dist folder and to the archive
 - dist - contains SVR.JS, assets, and SVR.JS utiltiies
 - generatedAssets - assets generated by the build script
 - out - contains SVR.JS zip archive
 - src - contains SVR.JS source code
   - index.js - entry point
   - handlers - handlers for servers
   - middleware - built-in middleware for servers
   - res - resources
   - utils - utility functions
 - templates - EJS templates for build script to use
 - tests - Jest unit tests
   - middleware - tests for middleware
   - utils - unit tests for utility functions
 - utils - SVR.JS utilities (each utility has a single file)
 - esbuild.config.js - the build script
 - eslint.config.js - ESLint configuration
 - jest.config.js - Jest configuration
 - svrjs.json - SVR.JS version, name, documentation URL, and statistics server collection endpoint URL