An open API service indexing awesome lists of open source software.

https://github.com/andrewjbateman/angular-tailwind-akita

:clipboard: Angular app to show data that is handled by Akita state management.
https://github.com/andrewjbateman/angular-tailwind-akita

akita angular angular13 tailwind tailwindcss work-in-progress

Last synced: 6 months ago
JSON representation

:clipboard: Angular app to show data that is handled by Akita state management.

Awesome Lists containing this project

README

          

# :zap: Angular Tailwind Akita

* Angular app using [Akita State Management](https://www.npmjs.com/package/@datorama/akita) & [Tailwindcss](https://developers.google.com/chart/) components to display API data
* **Note:** to open web links in a new window use: _ctrl+click on link_

![GitHub repo size](https://img.shields.io/github/repo-size/AndrewJBateman/angular-tailwind-akita?style=plastic)
![GitHub pull requests](https://img.shields.io/github/issues-pr/AndrewJBateman/angular-tailwind-akita?style=plastic)
![GitHub Repo stars](https://img.shields.io/github/stars/AndrewJBateman/angular-tailwind-akita?style=plastic)
![GitHub last commit](https://img.shields.io/github/last-commit/AndrewJBateman/angular-tailwind-akita?style=plastic)

## :page_facing_up: Table of contents

* [:zap: Angular Tailwind Akita](#zap-angular-tailwind-akita)
* [:page\_facing\_up: Table of contents](#page_facing_up-table-of-contents)
* [:books: General info](#books-general-info)
* [:camera: Screenshots](#camera-screenshots)
* [:signal\_strength: Technologies](#signal_strength-technologies)
* [:floppy\_disk: Setup](#floppy_disk-setup)
* [:wrench: Testing](#wrench-testing)
* [:computer: Code Examples](#computer-code-examples)
* [:cool: Features](#cool-features)
* [:clipboard: Status \& To-Do List](#clipboard-status--to-do-list)
* [:clap: Inspiration](#clap-inspiration)
* [:file\_folder: License](#file_folder-license)
* [:envelope: Contact](#envelope-contact)

## :books: General info

* API data displayed in a responsive grid of cards styled with Tailwind. Clicking on a card toggles a modal to open/close with the full API post data
* Angular 12+ has built-in Tailwind support
* To build for production Tailwind’s purge option is used to tree-shake unused styles and optimize final build size.
* [Free svg site](https://freesvg.org/) for svgs
* The [structuredClone() method](https://developer.mozilla.org/en-US/docs/Web/API/structuredClone) creates a deep clone (any changes to it will not affect the original and vice versa) of a value

## :camera: Screenshots

![Angular page](./img/home.jpg)

## :signal_strength: Technologies

* [Angular framework v16](https://angular.io/)
* [Akita State Management for JS v8](https://www.npmjs.com/package/@datorama/akita).
* [Reactive Extensions Library for Javascript rxjs v7](https://rxjs.dev/)
* [Tailwindcss v3](https://tailwindcss.com/) CSS framework

## :floppy_disk: Setup

* Run `npm i` to install dependencies.
* Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files.
* Run `npm run build` for a production build with css purging.
* The build artifacts will be stored in the `dist/angular-tailwind-akita` directory.

## :wrench: Testing

* no testing set up

## :computer: Code Examples

* tba

```typescript
tba
```

## :cool: Features

* tba

## :clipboard: Status & To-Do List

* Status: Working, 3 type errors.
* To-Do: Fix type errors, Add styling

## :clap: Inspiration

* [Akita docs](https://www.npmjs.com/package/@datorama/akita)
* [Comment résoudre le problème "Object is of type 'unknown" en TypeScript ?](https://www.journaldunet.fr/web-tech/developpement/1516455-comment-resoudre-le-probleme-object-is-of-type-unknown-en-typescript/)

## :file_folder: License

* This project is licensed under the terms of the MIT license.

## :envelope: Contact

* Repo created by [ABateman](https://github.com/AndrewJBateman), email: `gomezbateman@yahoo.com`