Skip to content

Latest commit

 

History

History
150 lines (101 loc) · 5.7 KB

README.md

File metadata and controls

150 lines (101 loc) · 5.7 KB

brimble NPM

Brimble

Brimble


Brimble is your go-to cloud platform for deploying front-end web applications.

Streamline your frontend deployment. Effortlessly package and deliver web code. Optimize loading times for seamless user experiences. Simplify your workflow with Brimble.

Prerequisites

Quick start

Getting started

  • Fork the repo here
  • Clone the repository ✅
  • Add your template here by making changes to templates.json ✅
  • Create a branch with the name: brimble/template-name
  • Upload your banner image here
  • Mark your repository as a template, on the settings page ✅
  • Add brimble badge to readme ✅
  • Create a Pull Request ✅
  • Wait for your template to go live 🚀

Example

[
  {
    "githubUrl": "https://github.com/pipethedev/templates",
    "categories": [
      "e-commerce",
      "health-fitness"
    ],
    "deploymentUrl": "https://templates.brimble.app"
  }
]
Supported Categories

Template Categories

  • Portfolio: Templates for showcasing personal or professional portfolios, including artists, designers, photographers, and developers. portfolio

  • E-Commerce: Templates tailored for online stores, enabling users to easily sell products and services. e-commerce

  • Blog: Templates for bloggers to share articles, stories, and insights on various topics. blog

  • Corporate: Professional templates suitable for corporate websites, highlighting company information, services, and contact details. corporate

  • Startup: Templates aimed at startup companies, focusing on product features, team profiles, and value propositions. startup

  • Event: Templates for promoting and managing events, conferences, workshops, and other gatherings. event

  • Restaurant: Templates for restaurants and cafes, showcasing menus, location details, and reservation options. restaurant

  • Personal Blogging: Templates tailored for personal bloggers to express thoughts, ideas, and experiences. personal-blogging

  • Nonprofit: Templates for nonprofit organizations to raise awareness, share mission details, and collect donations. nonprofit

  • Education: Templates for educational institutions, providing information about courses, faculty, and admissions. education

  • Travel: Templates designed for travel agencies or travel bloggers to showcase destinations, itineraries, and travel tips. travel

  • Music/Band: Templates for musicians and bands to showcase their music, tour dates, and merchandise. music-band

  • Health/Fitness: Templates related to health and fitness, suitable for gyms, fitness coaches, and wellness blogs. health-fitness

  • Real Estate: Templates for real estate agents or agencies to display property listings and contact information. real-estate

  • Technology: Templates for tech-related companies or blogs, focusing on products, innovations, and industry insights. technology

  • Fashion: Templates for fashion designers, brands, or boutiques to showcase clothing lines and accessories. fashion

  • Art/Creative: Templates for artists and creatives to display their artwork, designs, and creative projects.art-creative

  • Freelancer/Consultant: Templates for freelancers and consultants to present their services, expertise, and client testimonials. freelancer-consultant

  • Community/Forum: Templates for creating online communities or discussion forums around specific topics. forum

  • News/Magazine: Templates designed for news websites or online magazines, featuring articles, headlines, and multimedia content. news/magazine

JSON fields

This is the JSON schema for templates.json.

Required properties

githubUrl String Your template url, you want live on brimble https://github.com/pipethedev/templates
categories Array Array of supported categories, for your template [ "e-commerce", "health-fitness" ]
deploymentUrl Array Deployment URL of your template on brimble "https://templates.brimble.app"

Brimble Badge

The URL of the badge is the repository URL


Brimble badge

Quick note

  • Providing an invalid json format would not get your pull request approved & merged.
  • Only provide supported categories as they are case-sensitive.
  • Deployment URL should only have the brimble.app subdomain.
  • Uploading a banner image is mandatory.
  • Absence of the brimble badge in your readme file could prevent pull request approval