/rasenganjs-templates

A bank of examples projects built with rasenganjs and other tools

Primary LanguageTypeScriptMIT LicenseMIT

Rasengan.js Templates

Rasengan.js Templates

License Version NPM Version

Welcome to the Rasengan.js Templates repository! This repository contains a variety of templates to help you get started with your Rasengan.js projects quickly and efficiently.

Table of Contents

Introduction

Rasengan.js is a powerful framework for building modern web applications with ease. This repository provides pre-prepared templates that you can use to kickstart your projects. Whether you are building a chatbot, an e-commerce site, a portfolio, or a dashboard, we have a template for you.

Templates

We currently offer the following templates:

Chatbot

  • Gemini
    • Description: Gemini chatbot template, a ready-to-go chatbot app.
    • Path: templates/chatbot/gemini
    • Language: TypeScript

Portfolio

  • Developer
    • Description: Developer portfolio template to showcase your projects to potential employers.
    • Path: templates/portfolio/developer
    • Language: TypeScript

Additional templates are planned for various other categories, including e-commerce, dashboards, and more. Certainly! Here's the revised "Usage" section of the README to accurately reflect the current process for using templates with the Rasengan.js framework:

Usage

To utilize a template with Rasengan.js, follow these streamlined steps:

  1. Explore Templates:

    • Visit templates.rasengan.dev to browse through the available templates.
    • Identify the template you want to use and copy its template-key.

  2. Generate New Project:

    • Use the Rasengan CLI to generate a new project based on your chosen template. This can be done without installing the CLI explicitly by using npx:

      npx create-rasengan@latest [project-name] --template <template-key>

    • If you do not specify the [project-name], the CLI will prompt you to enter it during the process.

For example, to create a project using the Gemini chatbot template, you would execute:

npx create-rasengan@latest my-chatbot-app --template chatbot/gemini

This method ensures you are always using the latest version of the Rasengan.js CLI and the most updated templates available.

What's Included

The repository is structured as follows:

  • templates/: Contains all the template folders.
    • chatbot/: Templates for chatbot applications.
      • gemini/: Gemini chatbot template.
    • portfolio/: Templates for portfolio websites.
      • developer/: Developer portfolio template.

Contributing

We welcome contributions from the community! Please read our Contribution Guidelines to get started. Contributions can be in the form of new templates, bug fixes, documentation improvements, and more.

Present Contributors

Resources

We use the following resources for the development of our templates:

Communication

Stay connected with us through our social media channels:

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project, you agree to abide by its terms.

License

This project is licensed under the MIT License - see the LICENSE file for details.