:rocket: How use

Instalation:

npm install simple-trello
#or
yarn add simple-trello

🛠️ Tools

For start using the simple-trello you need to create a trello api key and token. You can create it here.

First step is create a instance of SimpleTrello class passing your key and token.

// import libary
import { SimpleTrello } from 'simple-trello';

// create instance
const simpleTrello = new SimpleTrello({
  key: "your-key",
  token: "your-token",
});

after that you can use the methods to interact with trello api.

Create card

// create new card
const card = await simpleTrello.createCard({ listId, title, description });

Get boards

// get all boards
const boards = await simpleTrello.getBoards();

Get lists

// get all lists from board
const lists = await simpleTrello.getLists({ boardId });

Get cards

// get all cards from list
const cards = await simpleTrello.getCards({ listId });

🧪 Tests

To run the tests you need to create a .env file in the root of the project with the following content:

API_KEY=your-key
API_TOKEN=your-token
LIST_ID=your-list-id
BOARD_ID=your-board-id

After that you can run the tests with the following command:

npm run test
#or
yarn test

📝 Contributing

Your contribution to the simple-trello is essential for the evolution of the project, you can do it as follows:

• Open an issue to clear doubts, report bugs or give ideas
• Open a pull request to give ideas for code improvement, implementation of new features and bug fixes

These are just some of the ways you can contribute to the project read the CONTRIBUTING for more information

🧑 Authors

✨ Contributors

Thanks goes to these wonderful people (emoji key):

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

📄 License

simple-trello is a open source project licensed as MIT.