Introduction

Welcome to the @ipear/server (npm) docs. This documentation and the package are entirely based on API Documentation. This package is used to link your server to iPear.

We built few FiveM resources (free/MIT) with this package: GitHub repositories

All this documentation is based on NodeJS v16, so we recommend that you use at least NodeJS version 16. We do not provide support for older versions.

Bugs

If you find a bug with the API or incorrect or out-of-date documentation, you can contact us on our Discord server.

Support

We give technical support on our Discord (create ticket or post in the forums for customers/developers) or email us [email protected]

Before we start

You need a secret key (SECRET) and an endpoint URL (ENDPOINT). These information can be obtained in your customer area > Your project > Your server > "Production mode" option.

Without a server in production mode, you cannot obtain the secret key and the endpoint. Once the production mode is activated, an endpoint and a secret key will be generated for you.

Knowledge requirements

You must be familiar with the management of NPM modules and the javascript language.

Ready?

If you think you are ready, you can start with getting started.