Configuration

Basic Config

The config is simple ! You will see a quickstart config !

{
    "database": {
        "host": "localhost",
        "user": "root",
        "pass": "root",
        "name": "towny"
    },
    "port": 7000,
    "baseURL": "api",
    "residentURL": "resident",
    "townURL": "town",
    "nationURL": "nation",
    "welcomePhrase": "Welcome on servername Towny Data API !",
    "logConnections": true,
    "maxSize": 5000
}

Just edit the database informations, and others if you want (See more here)

Then you can execute node index.js !

Advanced Config

Line par Line explaination

Database config, set the host, the user, the password and the database name :

"database": {
        "host": "localhost",
        "user": "root",
        "pass": "root",
        "name": "towny"
},

Change the port of the express server : (Int)

"port": 7000,

Base URL of your api (yourdomain/baseURL) : (String)

"baseURL": "api",

URL for resident requests (yourdomain/baseURL/residentURL) : (String)

"residentURL": "resident",

URL for town requests (yourdomain/baseURL/townURL) : (String)

"townURL": "town",

URL for resident requests (yourdomain/baseURL/nationURL) : (String)

"nationURL": "nation",

Welcome phrase on yourdomain and yourdomain/api : (String)

"welcomePhrase": "Welcome on servername Towny Data API !",

Do you want connections to be logged (No IP for sure) : (Boolean)

"logConnections": true,

Max request size, for mass requests like fetch residents : (Int)

//NOTICE : Big Values can broke your server
"maxSize": 5000

That's all !

Let's see how our API works :