Git Product home page Git Product logo

nimbly-lite's Introduction

Nimbly Lite


Compatible browsers

Requirements

  1. Create a HubSpot development sandbox for testing and development purposes. Link

  2. Create a personal CMS access key to enable authenticated access to your account. Link

Quick start

  1. npm install - install all development dependencies
  2. Add to .env file your portal name and PERSONAL_ACCESS_KEY Read more
  3. npm run upload - upload all local changes to remote HubSpot portal check more commands

nimbly-lite's People

Contributors

dmh avatar flabbykitty avatar pxamike avatar dudnikgg avatar pixelmatseriks avatar mesosa avatar

Forkers

pxamike dudnikgg

nimbly-lite's Issues

[BUG] Sticky header functionality does not work

Describe the bug
Sticky header functionality does not work. After the Sticky header toggle was switched ON, asset changes were published and saved, but still, nothing has happened to the site header.

To Reproduce
Steps to reproduce the behavior:

  1. Go to the Website pages in the HubSpot account.
  2. Click on Create button -> Website page and create a new page based on the Nimbly Light theme (Strat page template) OR use the existing page based on this theme.
  3. Click on the Edit button to open the page in the Editing mode
  4. Click on the Contents tab -> Global header settings
  5. In the pop-up form click on the 'Open in global content editor' button
  6. In the opened editor click again on the Contents tab -> Sticky header
  7. Switch the toggle ON
  8. In the right top corner click on the 'Publish to _ assets" button to save changes
  9. Once changes were saved and the user was returned to the webpage (Editing mode) click on the 'Update' button in the right top corner
  10. Open the saved page in the preview mode or in the new window tab

Expected behavior
After the Sticky header toggle was changed to ON site header menu should be sticky.

Additional context
Tested on 2 accounts with Nimbly v.2 (one sandbox account with Nimbly Light v.2 and one demo account after updating Nimbly Light from v.1 to v.2)

Theme performance

Using Google Lighthouse, a theme must score higher than the following thresholds:

  • Desktop accessibility: 65
  • Desktop best practices: 80
  • Desktop performance: 70
  • Mobile performance: 40

Asset Variants As Separate Submissions Are Not Permitted

Submitting assets with different variations of the following is not permitted:

  • Color Variations: Submitting an asset with a blue color scheme and then submitting the same asset with a red color scheme does not equate to being unique separate instances of an asset.
  • Template Layouts: Submitting an asset such as “Landing page with Right Sidebar” and “Landing Page with Left Sidebar” where the sidebar is simply swapped does not equate to being unique separate instances of an asset.
  • Content Variation: Submitting an asset with content that is focused on Education and submitting the same asset with content focused on Real Estate does not equate to being a unique separate instance of an asset.

Having color variants, layout placement options and customizable content are core features of HubSpot’s Platform offering.

Designs must display high aesthetic quality and be visually appealing

  • Designs are too similar to existing items: Your design closely resembles an existing listing and could cause confusion in differentiating them.
  • Inconsistent spacing, padding, margin, or line-heights on elements: Your design has inconsistent spacing among the elements causing users to be unable to visibility discern between sections or groups of texts.
  • Use of inappropriate, watermarked, pixelated, or unlicensed imagery: Your design must use imagery that is appropriate. Images that are found through a search engine “image” search are not licensed for public use. If you are looking for free images, we recommend reading our blog post about free image sites.
  • Use of colors that are not complementary: Your design should contain a color scheme that is aesthetically pleasing. When choosing color schemes, we strongly encourage you to think of accessibility standards in order to create an inclusive design.
  • Misaligned or inconsistently-placed elements: Your design should have a logical visual flow and not cause visual clutter. An example of this would be having floating text boxes unintentionally overlapping in areas where text wouldn’t be expected to be placed.

Theme.json

Your theme.json file must include the following parameters:

JSON
// theme.json

{
    "label": "Your Theme Name",
    "preview_path": "./path/to/preview-page.html",
    "screenshot_path":"./path/to/screenshot.jpg",
    "enable_domain_stylesheets": false,
    "version":"1.0",
    "author":{
      "name":"Your Marketplace Provider Name",
      "email":"[email protected]",
      "url":"https://theme-provider-url.com/"
    },
    "documentation_url":"https://theme-provider-url.com/your-theme/documentation",
    "example_url":"https://theme-provider-url.com/your-theme/demo"
}

Default Content in Templates

Default content must match what is advertised on the asset listing page and demo site. All verbiage, images, and other media used on the asset listing page should match what is used in the demo site and asset.

For example, if your asset listing is about a landing page that is geared towards real estate with a working demo and upon purchase of this asset, the end user is delivered a landing page about fitness, this would be considered a bait-and-switch which is unacceptable.

Theme, template and module errors

A theme, along withes its templates and modules, must not display any errors in either the Design Tools or the browser console. An example of errors inside of the Design Tools are shown below:

[BUG] Accessibility works badly on the Safari/ Firefox browsers

Describe the bug
Accessible navigation via the Tab key works incorrectly on the Safari and Firefox browsers.

To Reproduce
Steps to reproduce the behavior:

  1. Open Safari or Firefox browser on your machine
  2. Open a webpage based on the Nimbly Light theme (e.g. Start page)
  3. Start to navigate on the webpage via the Tab key
  4. See the error

Actual result
While navigating via the Tab key on the website page navigation works only for the Search icon/field. No possibility to navigate buttons/ links on the rest of the website page (including the main menu)

Expected behavior
Navigation via the Tab key works for the whole site's accessible elements (buttons, links, linked images/icons, form fields, etc.)

Screenshots
Screenshot 2023-03-14 at 20 13 26
Screenshot 2023-03-14 at 20 14 32

Desktop:

  • OS: macOS, Windows
  • Browser: Safari
  • Version 16.3 (18614.4.6.1.6)

Desktop:

  • OS: macOS, Windows
  • Browser: Firefox
  • Version 111.0 (64-bit)

Forms + Forms global settings

Form fields:

  • Title background
  • Title text, including at least font color styles
  • Form background color
  • Form border color
  • Form label color
  • Form field border color
  • Form button, including settings for both button text, background color, and hover styling

Nimbly Pro checklist

?? Page Templates

  • Home
  • About
  • Contact
  • Blog list
  • + Blog list Pro
  • Blog post
  • + Blog post Pro
  • + Event list
  • + Event details
  • Landing page
  • + Landing page 2
  • + Product
  • + Pricing
  • + Documentation
  • + Filter content ????
  • + Downloads

10 System Templates

  • 404
  • 500
  • Password prompt template
  • Subscription template
  • Subscriptions update template
  • Backup unsubscribe template
  • Search results template
  • + Search results template Pro
  • + Membership login
  • + Membership registration

?? Modules

  • Audio
  • + Video
  • Blog list
  • Blog pagination
  • Blog recent
  • Blog related
  • + Blog Comments
  • + Blog Email Subscription
  • + Post Filter
  • Button
  • Card
  • F.A.Q.
  • Heading
  • Hero Image
  • Icon
  • Image | Card
  • Image
  • Link
  • RichText
  • Site header
  • Social links
  • + Follow Me links vs Social links
  • + Social Sharing vs Follow Me links vs Social links
  • SVG divider
  • Divider
  • Text
  • Form
  • Logo
  • Site Search Input
  • Site Search result
  • + Image slider
  • + Image Gallery
  • + Pricing Cards
  • + Tabs
  • + Accordion
  • + Meetings
  • + Events
  • + Menu
  • + Simple menu
  • + Breadcrumbs
  • + HTML module
  • + RSS List
  • + ... depend on design

Sections
depend on design

Nimbly Lite checklist

6 Page Templates

  • Home
  • About
  • Contact
  • Blog list
  • Blog post

7 System Templates

  • 404
  • 500
  • Password prompt template
  • Subscription template
  • Subscriptions update template
  • Backup unsubscribe template
  • Search results template

24 Modules

  • Audio
  • Blog list
  • Blog pagination
  • Blog recent
  • Blog related
  • Button
  • Card
  • F.A.Q.
  • Heading
  • Hero Image
  • Icon
  • Image | Card
  • Image
  • Link
  • RichText
  • Site header
  • Social links
  • SVG divider
  • Divider
  • Text
  • Form

Sections
depend on design

Theme Limits

Keep in mind the following limits per theme:

Themes cannot contain more than:

  • 50 templates
  • 50 modules
  • 50 sections

Themes must not contain:
Email templates (at this time, themes do not support email templates).

  • HubDB functionality.
  • Serverless functions.
  • CRM object fields.
  • Membership templates.

[BUG] Links alignment is incorrect

Describe the bug
Links have incorrect alignment:

  • the link text is displayed lower than other text <p> in the Rich Text module;
  • the same issue happens for the Link module/ Heading module. But in these modules, it's not so much visible;

Expected behavior
The linked text (link) should be aligned vertically along with other text

Screenshots
Screenshot 2023-06-08 at 13 21 02

Additional context

:where(a:not(.btn-link)) {
vertical-align: unset;
}

Simple design for nimbly-light

Simple Company site

6 Page Templates

  • Home
  • About
  • Contact
  • Blog list
  • Blog post
  • Landing

7 System Templates

  • 404
  • 500
  • Password prompt template
  • Subscription template
  • Subscriptions update template
  • Backup unsubscribe template
  • Search results template

Needs:
"Real" default content (not lorem ipsum)
With free-to-use default images
With logo (two color variants?)

Redundant or Unnecessary Code

Your asset must not include any code or items that are not necessary for the asset to function. This includes, but is not limited to, items such as:

  • Unused style sheets or scripts
  • Commented out code
  • Unused code

Note: There is a difference between commented out code and comments in code. If you are providing context in your code for clarification purposes, we recommend using the comment delimiter as this will let you comment on your code while also not having these comments show in the “View Source” or “Inspect” views of a page. See below for an example.

Descriptive Naming Conventions

You must use descriptive naming conventions when labeling your assets. For example, if you are creating a module that allows users to show images in a gallery listing format with filters:

  • Good Naming: Image Gallery with Filters
  • Bad Naming: Gallery

When creating templates, we recommend looking at our developer documentation around template annotations and use of the label annotation which controls the label individuals see when choosing a page template in the page creation flow.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.