Package Exports

quicky-server
quicky-server/bin/src/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`

☂ A fast json server built to be flexible and easy-to-use. Inspired in json-server. ☂

GitHub top language Repository size GitHub LICENSE

✨ Features

Fancy UI: A minimal UI that exposes everything you need
Colorized Outputs: Everything looks better with some colors
Nice help: If you need some help, just use quicky-server -h
No config: You can give it a .json from the web (like this)
Configured CORS: Connect it with all your applications
Software Architecture:
- Restful
- GraphQL
- RPC

⬇️ How to install and use it

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

# Or

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

# Example (restful)
npx quicky-server -p 8080 -j https://raw.githubusercontent.com/kauefraga/quicky-server/main/mock/users.json

# Example (graphql)
npx quicky-server --graphql -j https://raw.githubusercontent.com/kauefraga/quicky-server/main/mock/users.json

⬇️ How to develop and contribute

git clone https://github.com/kauefraga/quicky-server.git
cd quicky-server

npm install
npm run dev -j mock/users.json # -h

You are welcome to open issues and pull requests!

💻 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)
🤖 Commander - The command line helper
🔮 Express - "Fast, minimalist web framework for Nodejs..."
🌠 GraphQL - A software architecture different from restful
🧙‍♂️ Apollo Server - A GraphQL server
💄 Code styling with Eslint
- https://www.npmjs.com/package/eslint-config-airbnb-base
- https://www.npmjs.com/package/eslint-config-airbnb-typescript
⚗️ Vitest - Test runner that implements Jest but with its own ESbuider (out of box typescript, esmodules...)
👩‍💻 Typescript + TS-Node-Dev - Improve dev experience by adding type safety

📑 Coming soon...

Create a server with GraphQL support
Watch .json changes (here we'll need Chokidar)

📝 License

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