# SleekwareDB - Open Source

> This is the first open source project I've created and it still needs a lot of help from contributors. Please feel free to view and provide feedback, suggestions, or ideas.

{% github https://github.com/SleekwareDB/sleekwaredb %}

NoSQL API with [SleekDB](https://sleekdb.github.io/). This project was created as an alternative to the existing NoSQL database services on the Internet. [SleekDB](https://sleekdb.github.io/) is an API for File-based NoSQL database management built on top of the [SleekDB](https://sleekdb.github.io/).

## About

What is SleekwareDB? SleekwareDB is a NoSQL database storage service. A database storage service that can be used for various platforms and is easy to integrate.

SleekwareDB is an Open Source project, anyone can contribute to build a better SleekwareDB for the future.

## Features

### 🗃️ Flat File Database
Easy to manage flat file JSON as database
### 🌐 **REST API Operation**
CRUD Stores and Collections with Easy REST API
### ✨ **Cross Platform**
Integrate with any Platform
### 🖥️ Self-Hosted
Install on your server with easy installation process
### ☁️ Web UI Dashboard
Manage Teams, Projects, Apps, Stores, Collection, etc with easy UI
### 🚀 Customized Your App
Feel free to customize this app, deep dive in SleekwareDB Source Code

## Requirements

- PHP ^7.4|8.0
- ext-json
- ext-mbstring

## Installation (Not Yet Available)
```bash
composer create-project sleekware/sleekware
```

## Contributing
Please to read [Code of CONDUCT](https://github.com/SleekwareDB/sleekwaredb/CODE_OF_CONDUCT.md) before start to contribute.
### ✍️ As a Technical Writer
The project requires contributors who are able to create manual presentations for users or developers. Visit [Discussions](https://github.com/SleekwareDB/sleekwaredb/discussions/categories/documentation) Page

### 👨‍💻 As a Developer
This project requires contributions from many developers to be of good use in the future.

As a developer, to be able to unite the vision and mission of the community, it's worth reading how SleekwareDB was developed and built using several technologies:

- [SleekDB](https://sleekdb.github.io) - A NoSQL Database made using PHP
- [AdminLTE](https://adminlte.io) - AdminLTE Bootstrap Admin Dashboard Template
- [RestServer](https://github.com/chriskacerguis/codeigniter-restserver) - CodeIgniter RestServer
- [Codeigniter](https://github.com/bcit-ci/CodeIgniter) -  Open Source PHP Framework (originally from EllisLab)

### 💡 As a Scientist
As an active contributor by providing practical suggestions and ideas that can be useful for the community. Visit [Discussions](https://github.com/SleekwareDB/sleekwaredb/discussions/categories/ideas) Page

Read more about [CONTRIBUTING](https://github.com/SleekwareDB/sleekwaredb/CONTRIBUTING.md)