SweetDB

---

Simple, usable and beginny-friendly database manager written in Typescript

📝 Table of Contents

• About
• Getting Started
• Manual installation
• Build
• Usage
• TODO
• Contributing
• Authors

🧐 About

SweetDB is a data storage system written in Typescript. It has its own schematics format and it's stored temporarily.

🏁 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 Manual installation for notes on how to install the project on a live system.

Prerequisites

To install SweetDB, you will need:

Node.JS > 13
NPM > 6

Installing

---

🔧 Running the tests

To run the tests:

 yarn test

Break down into end to end tests

No tests for the moment.

And coding style tests

The linter is present in order to allow anyone to be able to contribute while being in the main coherence of the code.

 yarn lint

🎈 Usage

No usage informations for the moment.

🚀 Manual installation

To deploy SweetDB, do:

 $ git clone git@github.com:nessmc/sweetdb.git

 # OR

 $ git init
 $ git remote add origin git@github.com:nessmc/sweetdb.git
 $ git pull

 # OR

 $ docker pull nessmcfr/sweetdb
 $ docker run nessmcfr/sweetdb

🚀 Build

To build the project, do:

 $ yarn bundle 
 # That generate file called bundle.js, just run it with : node dist/bundle.js

 # OR

 $ docker-compose build
 # OR
 $ yarn docker:build

 $ docker run sweetdb_app
 # OR
 $ yarn docker:start

✍️ Authors

• @NessMC - Idea & Initial work

See also the list of contributors who participated in this project.