-
Notifications
You must be signed in to change notification settings - Fork 687
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Removed useless directories and renamed files * Removed last remaining directory * Removed unused dependencies * Added update checking * Added beautiful help * Added basic serving functionality * Got rid of weird style * Renamed license file * Adjusted readme to new core * Made clear what's required * Be clear that it behaves like Now * Be even more clear * Perfected intro * Cleaned up the readme * Ensured linting is working * Upload only what's necessary * Made line shorter * Allow for custom configuration * Made logged messages perfect * Log sweet error when wrong argument is provided * Upgraded serve-handler * Upgraded serve-handler again to fix bugs * Allow force-closing * Ensured middleware as it its latest
- Loading branch information
Showing
22 changed files
with
432 additions
and
4,494 deletions.
There are no files selected for viewing
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,58 @@ | ||
# serve | ||
|
||
[![Build Status](https://circleci.com/gh/zeit/serve.svg?&style=shield)](https://circleci.com/gh/zeit/serve) | ||
[![Join the community on Spectrum](https://withspectrum.github.io/badge/badge.svg)](https://spectrum.chat/micro/serve) | ||
|
||
Assuming you would like to serve a static site, single page application or just a static file (no matter if on your device or on the local network), this package is just the right choice for you. | ||
|
||
It behaves exactly like static deployments on [Now](https://zeit.co/now), so it's perfect for developing your static project. Then, when it's time to push it into production, you [deploy it](https://zeit.co/docs/examples/static). | ||
|
||
Furthermore, it also provides a neat interface for listing the directory's contents: | ||
|
||
![screenshot](https://user-images.githubusercontent.com/6170607/40541195-167ff460-601b-11e8-8f66-3b0c7ff96cbb.png) | ||
|
||
## Usage | ||
|
||
Firstly, install the package using [Yarn](https://yarnpkg.com/en/) (you'll need at least Node.js LTS): | ||
|
||
```bash | ||
yarn global add serve | ||
``` | ||
|
||
Once that's done, you can run this command inside your project's directory: | ||
|
||
```bash | ||
serve | ||
``` | ||
|
||
Finally, run this command to see a list of all available options: | ||
|
||
```bash | ||
serve --help | ||
``` | ||
|
||
Now you understand how the package works! :tada: | ||
|
||
## Configuration | ||
|
||
To customize `serve`'s behavior, create a `serve.json` file and insert any of [these properties](https://github.com/zeit/serve-handler#options). In addition, `serve` will also detect `now.json` files if they contain the `static` property. | ||
|
||
## API | ||
|
||
The core of `serve` is [serve-handler](https://github.com/zeit/serve-handler), which can be used as middleware in existing HTTP servers. | ||
|
||
## Contributing | ||
|
||
1. [Fork](https://help.github.com/articles/fork-a-repo/) this repository to your own GitHub account and then [clone](https://help.github.com/articles/cloning-a-repository/) it to your local device | ||
2. Uninstall `serve` if it's already installed: `yarn global remove serve` | ||
3. Link it to the global module directory: `yarn link` | ||
|
||
After that, you can use the `serve` command everywhere. [Here](https://github.com/zeit/serve/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+for+beginners%22)'s a list of issues that are great for beginners. | ||
|
||
## Credits | ||
|
||
This project used to be called "list" and "micro-list". But thanks to [TJ Holowaychuk](https://github.com/tj) handing us the new name, it's now called "serve" (which is much more definite). | ||
|
||
## Author | ||
|
||
Leo Lamprecht ([@notquiteleo](https://twitter.com/notquiteleo)) - [ZEIT](https://zeit.co) |
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.