Skip to content

j3dog is a three-dimensional database solution for modern applications. It provides fault tolerance, distributed storage, and easy access to data.

License

Notifications You must be signed in to change notification settings

heusalagroup/j3.dog

Repository files navigation

ci.yml static.yml

j3dog is a research and development project from HG. It's a playground on how to use AI to design and organize an open source project and develop a new useful technology. For the most part, it does not exist yet. However, we hope it will soon.

j3.dog

j3dog is a three-dimensional database solution for modern applications. It provides fault tolerance, distributed storage, and easy access to data.

Features

  • REST API for easy integration
  • Spreadsheet app for easy data manipulation
  • Custom REST API creation for further integration
  • Fault tolerance through distributed storage
  • Easy deployment as a standalone database or as a module in a larger application

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

You will need the following to run j3dog:

  • A computer with a modern web browser
  • A stable internet connection

Installation

To install j3dog, follow these steps:

  1. Download the latest release from the releases page.
  2. Extract the downloaded file.
  3. Open the extracted folder and double-click the index.html file.
  4. The j3dog spreadsheet app will open in your web browser.

Deployment

To deploy j3dog on a live system, follow these steps:

  1. Download the latest release from the releases page.
  2. Extract the downloaded file.
  3. Upload the extracted folder to your web server.
  4. Access the index.html file through your web browser.

Built With

  • TypeScript - The programming language used
  • JavaScript - The programming language used in the minified end results
  • NodeJS - The backend solution used
  • React - The frontend solution used

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Documentation

Full documentation is available at https://j3.dog

Development with GitHub using SSH

To use SSH when working with submodules in this repository, you will need to configure your Git settings as follows:

git config --global url."git@github.com:heusalagroup/".insteadOf "https://github.com/heusalagroup/"

This configuration is necessary because the repository uses HTTPS links for read-only access. However, you may prefer to use SSH when pushing and pulling changes.

Support

For support, please visit https://j3dog.com/support.

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

License

j3dog is licensed under the MIT License. See LICENSE for more information.