LogBrew ☕

Simple and easy to use SDK to send logs to LogBrew ☕

What is it?

LogBrew is a simple and easy to integrate service that allows you to view logs visualy instead of just using the console of your app, While most just open up logs on thier phone via apps like Termius and use SSH to see what their app is doing, LogBrew allows you to have a clean and simple dashboard where you can send events that happen in your app. Using this service allows you to even send Push Notifications to your devices for urgent events like a sale happening on your E-Commerce website!.

We hope you enjoy using this platform and wish you the best on your brewing journey

How Do I use it?

Install The Package

yarn add logbrew
# Or
npm install logbrew

Create your Project on LogBrew.io And get your Credentials

First thing you need to do is get your Credentials, to do this; Head over to Our Website and create an account, you should see a screen like this when first logging in:

You are first going to want to create a project, you can do this by clicking the [+] button on the sidebar, Give your project a name and fill out the settings that the site prompts you to make.

After this is done, you are going to want to open up the project settings, head over to the API section and save your {Token} and {Project Name} Variables (Due to security, we only let you view the token when its first generated, Dont worry if you loose it, you can always regenerate it 😀)

Using the Package

Here is a basic app that will send us a sample message, you can use this to ensure that you have set everything up correctly

import Client from "logbrew"

const logbrew = new Client({
    token: "Your Project Token Here",
    project: "The Name of your project"
})

logbrew.sendLog({
    title: "Welcome to LogBrew",
    message: "Hello There new User! Welcome to LogBrew, This is your first event!, You can click me to view more!",
    emoji: "🎉",
    flags: [
        {name: "Welcome Event", color: "green"}
    ]
})

If you run this code (Make sure to swap in your token and project name) you should see an update on the dashboard with the details you provide

Contributors

| Name | GitHub | Social | | :- | :- | :- | | Thyke Adams ☕ | @ThykeAdams | @DevThyke Twitter |