Skip to content

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

License

Notifications You must be signed in to change notification settings

kauefraga/quicky-server

Repository files navigation

Quicky Server

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

GitHub top language Repository size GitHub last commit 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

📑 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.


Built with love Powered by coffee