Lona-Development/Docs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Small changes

Browse Source
This commit is contained in:
Collin 2023-07-06 22:17:07 +02:00
parent e74e38cbe2
commit 4e2395b7d0
2 changed files with 19 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
guide/getting-started.md
View File

@ -12,17 +12,25 @@ To install the LonaDB server, follow these steps:
1. Clone the repository to your local machine: 1. Clone the repository to your local machine:
```bash ```bash
git clone https://github.com/LonaDB/Server.git git clone https://github.com/LonaDB/Hadro.git
``` ```
2. Navigate to the project directory: 2. Navigate to the project directory:
```bash ```bash
cd Server cd Hadro
``` ```
3. Install the dependencies: 3. Install the dependencies and start the server:
```bash ```bash
npm install npm install
node hadro
``` ```
If you don't have a configuration file, a users file or any tables, the setup script will run you through initial setup and create everything needed for the database to run.
4. Use your database:
Thats it!
You now have your own instance of LonaDB's server, Hadro!

14
index.md
View File

@ -3,8 +3,8 @@ layout: home
hero: hero:
name: "LonaDB" name: "LonaDB"
text: "JSON based Database written in JavaScript" text: "JSON based and written in JavaScript"
tagline: LonaDB is an early-stage prototype of a JavaScript-based database. tagline: Simple, free and Open-Source.
actions: actions:
- theme: brand - theme: brand
text: Get Started text: Get Started
@ -15,10 +15,12 @@ hero:
features: features:
- title: What is LonaDB? - title: What is LonaDB?
details: LonaDB is an early-stage prototype of a JavaScript-based database. It utilizes JSON as its storage format and provides support for multiple users. details: LonaDB is an early-stage prototype of a JavaScript-based database. It utilizes Binary JSON as its storage format and provides support for multiple users and tables.
- title: Open-Source!
details: This is a Open-Source Project. This means that anyone can look at our source code. That way, we can't put a license check for example in our project.
- title: How does it work? - title: How does it work?
details: LonaDB is a server that runs on Node.js. It provides Client Libraries for interacting with the database. details: Hadro is our database server running in Node.js! It provides Client Libraries for interacting with the database. Also, it utilizes a TCP-Socket for communication with the clients.
- title: Self-Host - title: Your own instance!
details: LonaDB is self-hosted, meaning you can run it on your own server. This allows you to have full control over your data. details: LonaDB is self-hosted, meaning you can run it on your own server. This allows you to have full control over your data with no one spying.
--- ---