On GitHub, johnpapa/lite-server has picked up 2.3k stars, Backend, JavaScript. Lightweight node server
Snapshot summary built from the project's own GitHub metadata — there's no written TopGit review yet. The page will update automatically when a full review is published.
WHY NO REVIEW YET
TopGit writes full reviews for the most-starred, most-requested repositories. This page is a snapshot until then — see the READ ME tab for the original README in full.
Lightweight development only node server that serves a web app, opens it in the browser, refreshes when html or javascript change, injects CSS changes using sockets, and has a fallback page when a route is not found.
Why
BrowserSync does most of what we want in a super fast lightweight development server. It serves the static content, detects changes, refreshes the browser, and offers many customizations.
When creating a SPA there are routes that are only known to the browser. For example, /customer/21 may be a client side route for an Angular app. If this route is entered manually or linked to directly as the entry point of the Angular app (aka a deep link) the static server will receive the request, because Angular is not loaded yet. The server will not find a match for the route and thus return a 404. The desired behavior in this case is to return the index.html (or whatever starting page of the app we have defined). BrowserSync does not automatically allow for a fallback page. But it does allow for custom middleware. This is where lite-server steps in.
lite-server is a simple customized wrapper around BrowserSync to make it easy to serve SPAs.
Installation and Usage
The recommended installation method is a local NPM install for your project:
With the above script entry, you can then start lite-server via:
npm run dev
Other options for running locally installed NPM binaries is discussed in this Stack Overflow question: How to use package installed locally in node_modules
Using on the fly
lite-server can be used with npx
npx lite-server
Global Installation
lite-server can be also installed globally, if preferred:
npm install --global lite-server
# To run:
lite-server
Custom Configuration
The default behavior serves from the current folder, opens a browser, and applies a HTML5 route fallback to ./index.html.
lite-server uses BrowserSync, and allows for configuration overrides via a local bs-config.json or bs-config.js file in your project.
You can provide custom path to your config file via -c or --config= run time options:
lite-server -c configs/my-bs-config.js
For example, to change the server port, watched file paths, and base directory for your project, create a bs-config.json in your project's folder:
You can also provide custom path to your base directory --baseDir= run time options:
lite-server --baseDir="dist"
A more complicated example with modifications to the server middleware can be done with a bs-config.js file, which requires the module.exports = { ... }; syntax:
module.exports = {
server: {
middleware: {
// overrides the second middleware default with new settings
1: require('connect-history-api-fallback')({
index: '/index.html',
verbose: true,
}),
},
},
};
The bs-config.js file may also export a function that receives the lite-server Browsersync instance as its only argument. While not required, the return value of this function will be used to extend the default lite-server configuration.
module.exports = function (bs) {
return {
server: {
middleware: {
// overrides the second middleware default with new settings
1: require('connect-history-api-fallback')({
index: '/index.html',
verbose: true,
}),
},
},
};
};
NOTE: Keep in mind that when using middleware overrides the specific middleware module must be installed in your project. For the above example, you'll need to do:
A list of the entire set of BrowserSync options can be found in its docs: http://www.browsersync.io/docs/options/
Testing
When using lite-server to run end to end tests, we may not want to log verbosely. We may also want to prevent the browser from opening. These options in the bs-config.js will silence all logging from lite-server:
CSS with Angular 2 is embedded thus even though BrowserSync detects the file change to CSS, it does not inject the file via sockets. As a workaround, injectChanges defaults to false.
Contributing
Fork and clone it
Install dependencies: npm install
Create a feature branch: git checkout -b new-feature
Commit changes: git commit -am 'Added a feature'
Run static code analysis and unit tests: npm test
Push to the remote branch: git push origin new-feature
No homepage URL was recorded for johnpapa/lite-server in TopGit's last sync. The README tab above frequently contains screenshots and demo links, or check the repository description on GitHub.
How does johnpapa/lite-server compare to other Backend projects?
johnpapa/lite-server is tracked by TopGit in the Backend category, with 2.3k GitHub stars and written in JavaScript. Browse the Backend topic page on TopGit to compare it against similar projects by stars and activity.
How many stars does johnpapa/lite-server have?
johnpapa/lite-server has 2.3k GitHub stars — refresh the page for the live number, or check github.com/johnpapa/lite-server. TopGit mirrors GitHub's count but does not claim minute-by-minute accuracy.
Is johnpapa/lite-server open source?
Yes — johnpapa/lite-server ships under the MIT license, which makes its source code freely readable (and, depending on license terms, forkable and reusable). Source: github.com/johnpapa/lite-server.
What else is in the Backend space?
johnpapa/lite-server is tracked by TopGit under the Backend category, alongside 7 GitHub-tagged topics. Trending and Topics pages list peer repositories of comparable stars and language.
What is johnpapa/lite-server?
johnpapa/lite-server (johnpapa/lite-server) is a JavaScript project on GitHub. From the project's own README: Lightweight node server
Where do I read more about johnpapa/lite-server?
This TopGit page is a snapshot — the READ ME tab shows the project's own README content (links stripped, images preserved). The GitHub repository at github.com/johnpapa/lite-server is the definitive source.
Read full README in the tab above.
Is lite-server worth your time?
ChatGPT, Claude and Perplexity can all read this page. Ask one of them what it makes of lite-server.