Merge pull request #17 from marcode24/package

📦 update package

Author: marcode24

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Marco Antonio Cruz Gabino marco24cruz08@gmail.com
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

README.md

@@ -1,42 +1,68 @@
-# InfoReader Frontend
+<div align="center">
+  <h1>💻 Inforeader</h1>
+  <a href="https://inforeader.netlify.app/" target="_blank">View Demo</a>
+  <br/><br/>
 
-This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 13.2.2
+  ![Version](https://img.shields.io/github/package-json/v/marcode24/inforeader-frontend?style=popout&logo=npm)
+  ![GitHub CI Workflow Status](https://img.shields.io/github/actions/workflow/status/marcode24/inforeader-frontend/ci.yml?branch=main&style=popout&logo=testcafe&label=tests)
+  ![GitHub repo size](https://img.shields.io/github/repo-size/marcode24/inforeader-frontend?style=popout&logo=github&label=repo%20size)
+  ![GitHub](https://img.shields.io/github/license/marcode24/inforeader-frontend?style=popout&logo=github&label=license)
+  ![GitHub Repo stars](https://img.shields.io/github/stars/marcode24/inforeader-frontend?style=popout&logo=apachespark&color=yellow&logoColor=yellow)
+  ![Github repo views](https://img.shields.io/github/search/marcode24/inforeader-frontend/inforeader-frontend?style=popout&logo=github&label=repo%20views)
+  ![GitHub last commit](https://img.shields.io/github/last-commit/marcode24/inforeader-frontend?style=popout&logo=git&label=last%20commit)
+</div>
 
-## Get started
+## 🚀 Getting Started
 
-### Requirements
+This is a web application that allows you to read technology news, using RSS feeds from different sources and saving them in a database. It also allows you to create a user account and save your favorite news.
 
-- [Visual Studio Code](https://code.visualstudio.com/)
-- [Git](https://git-scm.com/downloads)
-- [NodeJs](https://nodejs.org/en/)
-- [Angular CLI](https://angular.io/cli)
+###  📝 Requirements
 
-### Clone the repo
+- [![Angular](https://img.shields.io/badge/Angular-blue?style=popout&logo=angular&logoColor=red)](https://angular.io/)
+- [![Node](https://img.shields.io/badge/Node-gray?style=popout&logo=node.js)](https://nodejs.org/en/)
+- [![NPM](https://img.shields.io/badge/NPM-blue?style=popout&logo=npm)](https://www.npmjs.com/)
+- [![Git](https://img.shields.io/badge/Git-gray?style=popout&logo=git)](https://git-scm.com/)
 
-```shell
-git clone https://github.com/marcode24/InfoReader-Frontend
-cd InfoReader-Frontend
-```
+Optional tools:
+
+- [![Visual Studio Code](https://img.shields.io/badge/Visual%20Studio%20Code-blue?style=popout&logo=visual-studio-code)](https://code.visualstudio.com/)
+
+### 📦 Installation & Usage
 
-### Install npm packages
+```bash
+# Clone this repository
+git clone https://github.com/marcode24/inforeader-frontend
 
-Install the `npm` packages described in the `package.json` and verify that it works.
+# Go into the repository
+cd inforeader-frontend
 
-```shell
+# Install dependencies
 npm install
-ng serve -o
+
+# Run the app
+ng serve
 ```
 
-Shut it down manually with `Ctrl+C`
+shut it down manually with `Ctrl-C` or `Cmd-C`.
+
+## 📐 Tests
 
-## Environments
+```bash
+# Run tests
+npm run test
 
-| Name       | URL                                      | PORT |
-| ---------- | ---------------------------------------- | ---- |
-| Localhost  | [localhost](http://localhost:4200)       | 4200 |
-| Production | [www.domain.com](https://www.domain.com) |
+# Run tests with coverage
+npm run test:cov
+```
+
+## 🌎 Environments
+
+| Name       | URL                                                                | PORT |
+| ---------- | -----------------------------------------------------------------  | ---- |
+| Localhost  | [localhost](http://localhost:4200)                                 | 4200 |
+| Production | [https://inforeader.netlify.app/](https://inforeader.netlify.app/) |
 
-## Folder Structure
+## 📁 Folder Structure
 
     .
     ├── src
@@ -59,16 +85,22 @@ Shut it down manually with `Ctrl+C`
     │ └── styles              # Global styles
     └── README.md
 
-## Previews
+## 📝 License
+
+This project is under the [MIT](./LICENSE) license. See the LICENSE for more information. 😉
+
+## 🖼️ Previews
+<details>
+  <summary>Click to expand!</summary>
 
-### Desktop
+### 🖥️ Desktop
 
 ![home-1](https://res.cloudinary.com/dfeujtobk/image/upload/v1658346332/InfoReader/home-1_gpqyqq.png)
 ![home-2](https://res.cloudinary.com/dfeujtobk/image/upload/v1658346331/InfoReader/home-2_hpojr8.png)
 ![home-3](https://res.cloudinary.com/dfeujtobk/image/upload/v1658346331/InfoReader/home-4_vqxco3.png)
 ![home-4](https://res.cloudinary.com/dfeujtobk/image/upload/v1658346331/InfoReader/home-3_qqeh64.png)
 
-### Mobile
+### 📱 Mobile
 
 ![mobile-1](https://res.cloudinary.com/dfeujtobk/image/upload/v1658346331/InfoReader/mobile-1_wjz51l.png)
 ![mobile-2](https://res.cloudinary.com/dfeujtobk/image/upload/v1658346331/InfoReader/mobile-2_d7umlp.png)