aplanalacurva/aplanalacurva-components

Aplana la curva Web Components

It's a set of components ready to works with design tokens.

Requeriments

Please note: This project uses Yarn Workspaces. If you want to run all demos locally you need to get Yarn and install all depencies by executing yarn install.

How to install

npm i @aplanalacurva/<package-name>

How to use

Use a Web Component

<script type="module">
  import '@aplanalacurva/chatbot/alc-chatbot.js';
</script>

<alc-chatbot>My button</alc-chatbot>

Extend a Web Component

import { AlcChatbot } from '@aplanalacurva/chat-bot';

class MyCustomChatbot extends AlcChatbot {}
customElements.define('my-custom-chat-bot', MyCustomChatbot);

Coding guidlines

Check out Lion Web Components coding guidelines for more detailed information.

How to contribute

Aplana la curva Web Components are only as good as its contributions. Read our contribution guide and feel free to enhance/improve Aplana la curva.

Contact

Feel free to create a gitlab issue for any feedback or questions you might have. You can also find us on Telegram in the #AplanaLaCurva channel.

Support and issues

As stated above "support and issues time" is currently rather limited: feel free to open a discussion. However, we can not guarantee any response times.

aplanalacurva-components's Issues

What is the license of the code?

Por lo que había entendido el proyecto es open source, así que debería indicarse en el README la licencia, para que la gente que quiera contribuir sepa bajo qué condiciones lo hace, y tener el fichero de la licencia también como parte del repositorio.

Mi recomendación es usar algunas de las licencias aprobadas por la Open Source Initiative.

Personalmente, siempre suelo elegir GPL v3, pero otras bastante habituales son MIT y Apache2.

¿Ya está decidida la licencia que se quiere aplicar?¿Qué condiciones de uso y redistribución se quieren permitir?

---

As I've understood, the project is gonna be an open source project. If so, the license should be mentioned and linked in the README file. That way, every contributor would know the terms for use, changes, and redistribution of the code.

My recommendation is to go for one of the approved Open Source Initiative licenses.

Personally, I usually go for GPL v3, but there are others usually used like MIT and Apache2.

Have you already chosen the license? What terms or conditions do you have on mind for code use, changes, and redistribution?