Package Exports

quicky-server
quicky-server/bin/cli/bin.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (quicky-server) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Quicky Server

GitHub top language Repository size GitHub LICENSE

☂ A fast json server built with native libraries as well as possible. Inspired in json-server. ☂

✨ Features

Fancy UI: A minimal UI that exposes everything you need
Colorized Outputs: Everything looks better with some colors
Tiny size: This package is built with native libraries
No config: You can give it a .json from the web (like this)

⬇️ How to install and use it

npm install -g quicky-server
quicky-server <port> <path || url>

# Or

npx quicky-server <port> <path || url>

# Example
npx quicky-server 8080 https://raw.githubusercontent.com/kauefraga/quicky-server/main/src/mock/example.json

⬇️ How to develop and contribute

git clone https://github.com/kauefraga/quicky-server.git
cd quicky-server
npm install
npm dev <port> <path || url>

Or downloading with yarn? yarn && yarn dev <port> <path || url>
Sincerely, i prefer pnpm, so: pnpm i && pnpm dev <port> <path || url>

💻 Technologies

NodeJS - A runtime based on V8 JavaScript
- 🌐 HTTP - The native http
- 🗃 FS - The file system
- 🗺 Path - A way to manipulate paths much easier (cross platform)
📡 Axios - Axios is a fully featured http client for doing requests
💄 Code styling with Eslint
- https://www.npmjs.com/package/eslint-config-airbnb-base
- https://www.npmjs.com/package/eslint-config-airbnb-typescript
👩‍💻 Typescript - Improve dev experience by adding type safety

📑 To do

Watch .json changes (here we'll need Chokidar)
Create a easily understandable --help section

📝 License

This project is licensed under the MIT License - See the LICENSE for more information.