Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Blog #22

Closed
wants to merge 10 commits into from
Closed

Blog #22

Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 0 additions & 26 deletions .forestry/settings.yml

This file was deleted.

1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,4 @@ package-lock.json
public
resources
wiki
.idea
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/images/blog/post-1/settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/images/blog/post-1/target-details.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/images/blog/post-1/targets-dashboard.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/images/favicon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/images/home/new-target.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/images/home/notification-settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/images/home/target-details.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/images/home/targets-dashboard.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/images/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
47 changes: 47 additions & 0 deletions config/_default/config.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
######################## default configuration ####################
baseURL = "https://velocapi.com/"
title = "Website and API Monitoring | Velocapi"
theme = "default"
# post pagination
paginate = "6"
# post excerpt
summaryLength = "10"

############################# Modules ##############################
[module]
[module.hugoVersion]
extended = true
min = "0.83.1"

############################# Outputs ##############################
[outputs]
home = ["HTML", "RSS", "WebAppManifest"]

[imaging]
quality = 90

[caches]
[caches.images]
dir = ":resourceDir/_gen"
maxAge = "720h"

[caches.assets]
dir = ":resourceDir/_gen"
maxAge = "720h"

[markup]
[markup.goldmark.renderer]
unsafe = true

[mediaTypes]
[mediaTypes."application/manifest+json"]
suffixes = ["webmanifest"]

[mediaTypes."text/netlify"]
delimiter = ""
suffixes = [""]

[outputFormats]
[outputFormats.WebAppManifest]
mediaType = "application/manifest+json"
rel = "manifest"
10 changes: 10 additions & 0 deletions config/_default/menus.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# main menu
[[main]]
name = "Home"
url = ""
weight = 1

[[main]]
name = "Blog"
url = "blog/"
weight = 2
File renamed without changes.
60 changes: 60 additions & 0 deletions config/_default/params.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
#################### default parameters ################################
# favicon
favicon = "images/favicon.png"
# logo
logo = "images/logo.png"
# use `x` with logo_width, example: "100x"
logo_width = "40x"
# logo text will only show when logo is missing.
logo_text = "Velocapi"
# OpenGraph / Twitter Card metadata
description = "Free Website and API monitoring - Make sure that your Website and APIs stay up and work as expected"
author = "Velocapi"
image = "images/logo.png" # this image will be used as fallback if a page has no image of its own

# footer information
footer_info = "Monitoring websites and API endpoints made easy."

# custom script on header, example: custom_script= "<script>console.log(\"Hello World\")</script>"
custom_script = ""

# Main Sections
mainSections = ["blog"]

# reading time for blog posts
reading_time = true

# contact information
[contact_info]
email = ["support@velocapi.com"]

# imaging processing
[imaging]
# Default JPEG or WebP quality setting. Default is 100.
quality = 100

# Preloader
[preloader]
enable = true
preloader = "images/favicon.png" # use jpg, png, svg or gif format.

# Navigation button
[navigation_button]
enable = true
label = "Sign Up"
link = "https://app.velocapi.com/auth/signup"

# cookies
[cookies]
enable = false
expire_days = 2
content = "This site uses cookies. By continuing to use this website, you agree to their use."
button = "I Accept"

# call-to-action
[cta]
enable = true
title = "Get Started For Free Now"
content = "Start to monitor your Website and API and do no longer worry about unnoticed issues and downtime."
button = "Sign Up"
button_link = "https://app.velocapi.com/auth/signup"
103 changes: 103 additions & 0 deletions content/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,103 @@
---
# banner
banner:
title: "Monitor your Websites and APIs in a Breath with Velocapi"
button: "Get Started for Free"
button_link: "https://app.velocapi.com/auth/signup"
image: "images/home/target-details.png"

# features
features:
enable: true
subtitle: "Features"
title: "Make sure that <br> your Website and APIs work as expected"
description: "Velocapi helps you to monitor your website and APIs <br> and notifies you if anything goes wrong."
features_blocks:
- icon: "las la-desktop"
title: "Monitoring"
content: "Velocapi polls your Website and API endpoints regularly and provides insights in out web application."
- icon: "las la-envelope"
title: "Notifications"
content: "Get notified instantly when something goes wrong. Velocapi integrates into Discord and Telegram."
- icon: "las la-tachometer-alt"
title: "Performance"
content: "Velocapi measures the performance of each request so that you can make sure that it's up to speed."
- icon: "las la-mobile"
title: "Mobile Ready"
content: "Monitor the status of your website and APIs while you're on the go to always stay on top of it."

# intro_video
intro_video:
enable: false
subtitle: "Short Intro Video"
title: "Built exclusively for you"
description: "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Morbi egestas <br> Werat viverra id et aliquet. vulputate egestas sollicitudin."
video_url: "https://www.youtube.com/embed/dyZcRRWiuuw"
video_thumbnail: "images/video-popup.jpg"


# how_it_works
how_it_works:
enable: true
block:
- subtitle: "Create New Targets"
title: "Add your websites or API endpoints to the monitoring"
description: "Easily add your website or API enpoints to the monitoring. You only need an URL to get started. For more complex use cases, you can specify a request body, request headers, or validation options."
image: "images/home/new-target.png"

- subtitle: "Keep The Overview"
title: "Get an overview of your monitored targets at a glance"
description: "See all your monitored websites and endpoints in one location to check if everything is working as intended. As a bonus, statistics like success and failure rates provide a better understanding of your websites and APIs."
image: "images/home/targets-dashboard.png"

- subtitle: "Investigate Issues"
title: "Delve into the details of your monitored targets"
description: "A detailed overview for each target lets you know what is going on. Information on issues and performance helps you to quickly recover from incidents."
image: "images/home/target-details.png"
- subtitle: "Know What's Going On"
title: "Receive notifications when something goes wrong"
description: "Setup notification clients to get informed immediately in case of unexpected behavior. We integrate with Discord and Telegram to get you notified in real time."
image: "images/home/notification-settings.png"


# testimonials
testimonials:
enable: false
subtitle: "Our Testimonials"
title: "Don't take our word for it"
description: "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Morbi egestas <br> Werat viverra id et aliquet. vulputate egestas sollicitudin."
image_left: "images/testimonials-01.png"
image_right: "images/testimonials-02.png"

testimonials_quotes:
- quote: "Lorem ipsum dolor amet, conseetur adipiscing elit. Ornare quam porta arcu congue felis volutpat. Vitae lectudbfs dolor faucibus"
name: "David Cameron"
designation: "CEO, Nexuspay"
image: "images/user-img/05-i.jpg"

- quote: "Conseetur adipiscing elit. Ornare quam porta arcu congue felis volutpat. Vitae lectudbfs pellentesque vitae dolor faucibus"
name: "David Cameron"
designation: "CEO, Nexuspay"
image: "images/user-img/06-i.jpg"

- quote: "Lorem ipsum dolor amet, conseetur adipiscing elit. Ornare quam porta arcu congue felis volutpat. Vitae lectudbfs pellentesque vitae dolor"
name: "David Cameron"
designation: "CEO, Nexuspay"
image: "images/user-img/07-i.jpg"

- quote: "Lorem ipsum dolor amet, conseetur adipiscing elit. porta arcu congue felis volutpat. Vitae lectudbfs pellentesque vitae dolor faucibus"
name: "David Cameron"
designation: "CEO, Nexuspay"
image: "images/user-img/08-i.jpg"

- quote: "Lorem ipsum dolor ame conseetur. Ornare quam porta arcu congue felis volutpat. Vitae lectudbfs pellentesque vitae dolor faucibus"
name: "David Cameron"
designation: "CEO, Nexuspay"
image: "images/user-img/09-i.jpg"

- quote: "Lorem ipsum dolor amet, conseetur adipiscing elit. Ornare quam porta arcu congue lectudbfs pellentesque vitae dolor faucibus"
name: "David Cameron"
designation: "CEO, Nexuspay"
image: "images/user-img/10-i.jpg"

---
File renamed without changes.
54 changes: 54 additions & 0 deletions content/blog/post-1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
---
date: "2023-02-12"
title: "Getting started with Velocapi"
author_info:
name: "Velocapi"
image: "images/logo.png"
draft: false
---

Velocapi helps you to easily monitor your websites and API endpoints to make sure that they are up and behave as expected.
The [Velocapi web app](https://app.velocapi.com) provides an overview at a glance and our integration with Discord and Telegram will always keep
you up to date.

To get started for free, simply [create an account](https://app.velocapi.com/auth/signup).
From there on, we'll walk you through the process of adding your first monitoring target.
It only takes about a minute!

### Monitor Your First Target
Log in to Velocapi and create a new target via the *Monitor Your First Target* (1) button:
{{< image src="images/blog/post-1/first-target-create.png" >}}

In the opened dialog, enter a URL (1), for example `https://velocapi.com`, and click on the `Monitor Target` button (2).
{{< image src="images/blog/post-1/first-target-create-dialog.png" >}}

That's it! You've just added your first target to the monitoring.
With the default settings, the target will be queried every 5 minutes.

For more complex use cases, there are a lot more options to configure your targets for example by changing the HTTP method, adding custom HTTP headers or validation options.

### Investigate the Status of Your Target
With our first target in place, you can find information about the status of the latest request for your target directly on the dashboard (1).
{{< image src="images/blog/post-1/targets-dashboard.png" >}}

To get more details, you can check out the target insights by clicking on the rightmost button in the *Actions* column (2).
The target insights contain information about the target (1), recent incidents (2), response times (3), and statistics (4).
{{< image src="images/blog/post-1/target-details.png" >}}

### Get Notified About Incidents
To reduce the time from an incident to its resolution, we recommend that you set up the notification client of your choice to be notified of each incident as soon as it occurs.

Currently, Velocapi integrates with [Discord](https://discord.com/) and [Telegram](https://telegram.org/).
To connect to the open the settings page (1) in the web application.
Here, you can add either add the Velocapi Discord bot (2) to your discord server or the Telegram bot (3) to your account by clicking the respective link.

We provide commands to retrieve instructions for both the Discord and Telegram bot.
For discord, send `!setup` to the Velocapi bot. For `Telegram`, send `\setup`.

{{< image src="images/blog/post-1/settings.png" >}}

The bot will respond with your user ID that you can then copy into the respective input field (4, 5) in the Velocapi web application.
Finally, select the Notification client of your choice (6) and save the settings (7).

With that, you are good to go to stay on top of any incidents!

File renamed without changes.
File renamed without changes.
13 changes: 8 additions & 5 deletions netlify.toml
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
[build]
publish = "exampleSite/public"
command = "cd exampleSite && hugo --minify --gc --themesDir ../.."
publish = "public"
command = "hugo --minify --gc"

[build.environment]
HUGO_VERSION = "0.108.0"
HUGO_THEME = "repo"
HUGO_VERSION = "0.85.0"
HUGO_BASEURL = "/"

[[headers]]
Expand All @@ -15,3 +14,7 @@
X-XSS-Protection = "1; mode=block"
Referrer-Policy = "same-origin"
Strict-Transport-Security = "max-age=31536000; includeSubDomains; preload"
Content-Security-Policy = """
default-src 'self';
script-src 'self' 'unsafe-eval' apis.google.com;
object-src 'self'"""
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes.
14 changes: 14 additions & 0 deletions themes/default/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
Thumbs.db
.DS_Store
.dist
.tmp
.sass-cache
.hugo_build.lock
npm-debug.log
node_modules
builds
package-lock.json
public
resources
wiki
.idea
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
6 changes: 3 additions & 3 deletions config.toml → themes/default/config.toml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# This file is for render site varibles and plugins
# This file is for render site variables and plugins
# don't remove this file.
# The presence of this file is for compatibility with Blogdown and Forestry.
#
Expand All @@ -11,7 +11,7 @@
white = "#ffffff"
black = "#000000"
light = "#FAFAFA"
primary_color = "#FE6019"
primary_color = "#FD7E14"

# font variable
h1 = "48px"
Expand Down Expand Up @@ -56,4 +56,4 @@ link = "plugins/swiper/swiper-bundle.min.js"
[[params.plugins.js]]
link = "plugins/rellax/rellax.min.js"
[[params.plugins.js]]
link = "plugins/webfont-loader/webfont-loader-2.min.js"
link = "plugins/webfont-loader/webfont-loader-2.min.js"
Empty file.
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
######################## default configuration ####################
baseURL = "https://demo.gethugothemes.com/andromeda-light/site/"
title = "Andromeda-light - Software and SAAS Landing Hugo Theme"
theme = "andromeda-light"
theme = "landing-page"
# post pagination
paginate = "6"
# post excerpt
Expand Down
6 changes: 6 additions & 0 deletions themes/default/exampleSite/config/_default/module.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
[hugoVersion]
extended = true
min = "0.95.0"

[[imports]]
path = "github.com/gethugothemes/hugo-modules/shortcodes/image"
6 changes: 6 additions & 0 deletions themes/default/exampleSite/content/blog/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: "Blog"
description: "meta description"
draft: false
---

5 changes: 5 additions & 0 deletions themes/default/exampleSite/go.mod
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
module examplesite.com

go 1.18

require github.com/gethugothemes/hugo-modules/shortcodes/image v0.0.0-20220509155302-5976ca1fea3c // indirect
Loading