hyper63

A service framework making development productive and fun. For more information see Why hyper63

Docs · Discussions · Issues · Changelog

Introduction

👋 Hey 👋

Welcome to ⚡hyper63 open source project, above is plenty of links that can give you the why and what of hyper63, check them out! Also, if you are a hands on kind of developer, try out hyper63 using our playground and gitpod. You don't have to install anything to kick the tires ⚙️.

Status

• Development
• Alpha
• Beta
• v1.0

🧪 Try hyper63 using https://play.hyper63.com

You can take a 🎫 tour of the api starting here https://github.com/hyper63/tour

or watch a video here https://youtu.be/J75hYi6Gqgc

Running Locally

To run hyper63 on your local machine in your terminal type:

NOTE: make sure you have nodejs v14+ installed - https://nodejs.org

npx @hyper63/x

This command will run a hyper63 service on PORT 6363 and store data in ${HOME}/.hyper63 > [Ctrl/Cmd] - C will stop the service.

This nano version of hyper63 implements the following ports and adapters:

• DATA - @hyper63/adapter-pouchdb
• CACHE - @hyper63/adapter-memory
• STORAGE - @hyper63/adapter-fs
• SEARCH - @hyper63/adapter-minisearch (in memory)

Documentation

For more information about hyper63 go to our documentation site. https://docs.hyper63.com, if you are unable to find the information you are looking for, post a question in our discussions forum. https://github.com/hyper63/hyper63/discussions

Contributions

Our contributors guide will be coming out soon, for now, check out the project roadmap. https://github.com/hyper63/hyper63/projects/1

Contributing

Options to contribute:

• Write an adapter - create an adapter for a given port
• Write an client - create a client for your favorite language
• Write an app interface - create your own interface to the hyper63 service framework
• Documentation - update the documentation to be concise and clear
• Examples - create an example implementation.

Want to get involved read the following to find out how.

This is an opensource project, which welcomes all contributions and all development will occur in the open for interested parties to follow and comment. Please read the Code of Conduct and the Contributing documentation to fully understand the requirements and restrictions to be a part of this community.

Developer Setup

yarn
cd images/dev
yarn dev

Thank you

• OpenSource Community
• CharlestonJS Community
• JRS Coding School Team
• And everyone else that has helped this project become successful!