Skip to content

Reusable angular elements based on bootstrap 5.x and storybook

License

Notifications You must be signed in to change notification settings

jis248/raaghu-ng-elements

Repository files navigation

logo

Raaghu Ng Elements

tryshape licence tryshape forks tryshape stars tryshape issues tryshape pull-requests

View Demo · Report Bug · Request Feature

👋 Introducing raaghu-ng-elements

raaghu-ng-elements is an opensource micro front end framework built on top of Bootstrap 5 and Storybook offering highly customizable and reusable Angular UI elements.

Raaghu elements can be used as a base to build complex components and UI layouts whilst maintaining a high level of reusability.

🚀 Demo

Here is a quick demo of the elements. We hope you enjoy it.

Liked it? Please give us a ⭐️ to show your appreciation

Many Thanks to all the supporters who have helped this project with stars(⭐)

🔥 Features

🔢 High reusability

  • Promotes rusability throughout the UI and pages
  • Reduces code duplication and helps in delivering a more consistent and even UI

🏗️ Micro Front End Architecture

  • Each element is a separate micro front end on its own
  • Elements can be worked on in isolation

📢 Theming

  • The theming engine provides a way to set custom theme for all the elements
  • Control the theme of your project with only a few css variables

📱 Responsive and mobile-friendly

  • All of the elements are built for a wide variety of screen sizes

🏗️ How to Set up raaghu-ng-elements for Development?

You can run raaghu-ng-elements locally with a few easy steps.

  1. Clone the repository
git clone https://github.com/Wai-Technologies/raaghu-ng-elements.git
  1. Change the working directory
cd raaghu-ng-elements
  1. Install dependencies
npm install
  1. Set localDev environment variable in envronment.prod.ts for a particular element
export const environment = {
  production: true,
  localDev: false 
  // serve as micro frontend on 
  // localhost:3000/rds-<element name>/main.js
};
  1. Build and serve
# Build all projects and run server
npm run bootstrap 

# Build a single project and start server
npm run bootstrap -- --project=rds-<element name>
# For rds-input
# npm run bootstrap -- --project=rds-input

# Start server without building project
npm run bootstrap -- --build=false
  1. Storybook
# View all elements inside storybook
npm run storybook 

All set !! Now open localhost:3000/rds-<element name> to see the element locally or localhost:3000/rds-<element name>/main.js to serve it as a micro front end.

🍔 Built With

  • Bootstrap 5: Sleek, intuitive, and powerful framework for faster and easier web development.
  • Storybook: Build bulletproof UI components faster
  • Angular Elements: Build bulletproof UI components faster

🛡️ License

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

🦄 Upcoming Features

raaghu-ng-elements has all the potentials to grow further. Here are some of the upcoming features,

  • ✔️ Custom plugin to reveal the reusability within your angular project
  • ✔️ Ability to convert existing elements in a project into micro front end enabled elements
  • ✔️ Import custom elements into the library
  • ✔️ Better Performance
  • ✔️ Converiting plain angular components to custom elements

If you find something is missing, we are listening. Please create a feature request from here.

🤝 Contributing to Raaghu

Any kind of positive contribution is welcome! Please help us to grow by contributing to the project.

If you wish to contribute, you can work on any features listed here or create one on your own. After adding your code, please send us a Pull Request.

🙏 Support

We all need support and motivation. Raaghu is not an exception. Please give this project a ⭐️ to encourage and show that you liked it. Don't forget to leave a star ⭐️ before you move away.

If you found the app helpful, consider supporting us with a coffee.


A ⭐️ to Raaghu is to build its triceps 💪 stronger.

Contributor ✨

Thanks goes to these wonderful people


Apoorva Lele

Omkar Choudhari

Alok Nakhate

This project follows the all-contributors specification. Contributions of any kind welcome!

About

Reusable angular elements based on bootstrap 5.x and storybook

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published