Getting Started

To get started please run the following commands from your project directory. If you havent done so yet please make sure you have NodeJS installed. Please make sure you init your project by using the command below.

npm init --yes

Now in order to get started using our package as your server. Please run the following command.

npm i @shinerzoch/server

This command will install our package inside your application. This will allow you to use the below coding to get started.

Javascript NodeJS Module

// index.mjs

import Server from '../serverLibrary/index.js';
const port = 8080;

    // App logic goes here...    

Server.start(port);

Javascript NodeJS

// index.js

const Server = require('../serverLibrary/index.js');

(async () => {
    const port = 8080;
    
        // App logic goes here...   

    Server.start(port);
})();

Table Of Contents

Database Module

• Create Mysql Instance
• Create Local Instance
• Find One Data - Example
• Find Data - Example
• Save Data - Example
• Update Data - Example
• Delete Data - Example

AutoRoutes Module

• Enable Module

AuthSystem Module

• Enable Module
• Enable Module (Without Default Database)

Cookies Module

• Enable Module

Session Module

• Enable Module

Server Side Events Module

• Enable Module

WebSocket Module

• Enable Module

Database Module

Create Mysql Instance | Create Local Instance | Find One Data - Example | Find Data - Example | Save Data - Example | Update Data - Example | Delete Data - Example

You can set the default database by setting Server.db = DatabaseInstance. This is not a requirement, but it is recommended if you plan on using the database as your main projects database.

Create Mysql Database Instance ## {#database-mysql-create}

const db = await Server.Database.create("mysql", {
    modelsPath: "models",
    name: "default",
    host: "localhost",
    port: 3306,
    username: "testing",
    password: "testing",
    database: "testing",
});

Create Local Database Instance

This is a database that is completely file based and the contents are stored within your project. or any directory of choosing.

const db = await Server.Database.create("local", {
    name: "default", // Must be unqiue if not default.
    modelsPath: "models"
});