Skip to content

Commit 657119f

Browse files
committed
📝 update README
1 parent d179a30 commit 657119f

File tree

1 file changed

+59
-27
lines changed

1 file changed

+59
-27
lines changed

README.md

Lines changed: 59 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,68 @@
1-
# InfoReader Frontend
1+
<div align="center">
2+
<h1>💻 Inforeader</h1>
3+
<a href="https://inforeader.netlify.app/" target="_blank">View Demo</a>
4+
<br/><br/>
25

3-
This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 13.2.2
6+
![Version](https://img.shields.io/github/package-json/v/marcode24/inforeader-frontend?style=popout&logo=npm)
7+
![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)
8+
![GitHub repo size](https://img.shields.io/github/repo-size/marcode24/inforeader-frontend?style=popout&logo=github&label=repo%20size)
9+
![GitHub](https://img.shields.io/github/license/marcode24/inforeader-frontend?style=popout&logo=github&label=license)
10+
![GitHub Repo stars](https://img.shields.io/github/stars/marcode24/inforeader-frontend?style=popout&logo=apachespark&color=yellow&logoColor=yellow)
11+
![Github repo views](https://img.shields.io/github/search/marcode24/inforeader-frontend/inforeader-frontend?style=popout&logo=github&label=repo%20views)
12+
![GitHub last commit](https://img.shields.io/github/last-commit/marcode24/inforeader-frontend?style=popout&logo=git&label=last%20commit)
13+
</div>
414

5-
## Get started
15+
## 🚀 Getting Started
616

7-
### Requirements
17+
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.
818

9-
- [Visual Studio Code](https://code.visualstudio.com/)
10-
- [Git](https://git-scm.com/downloads)
11-
- [NodeJs](https://nodejs.org/en/)
12-
- [Angular CLI](https://angular.io/cli)
19+
### 📝 Requirements
1320

14-
### Clone the repo
21+
- [![Angular](https://img.shields.io/badge/Angular-blue?style=popout&logo=angular&logoColor=red)](https://angular.io/)
22+
- [![Node](https://img.shields.io/badge/Node-gray?style=popout&logo=node.js)](https://nodejs.org/en/)
23+
- [![NPM](https://img.shields.io/badge/NPM-blue?style=popout&logo=npm)](https://www.npmjs.com/)
24+
- [![Git](https://img.shields.io/badge/Git-gray?style=popout&logo=git)](https://git-scm.com/)
1525

16-
```shell
17-
git clone https://github.com/marcode24/InfoReader-Frontend
18-
cd InfoReader-Frontend
19-
```
26+
Optional tools:
27+
28+
- [![Visual Studio Code](https://img.shields.io/badge/Visual%20Studio%20Code-blue?style=popout&logo=visual-studio-code)](https://code.visualstudio.com/)
29+
30+
### 📦 Installation & Usage
2031

21-
### Install npm packages
32+
```bash
33+
# Clone this repository
34+
git clone https://github.com/marcode24/inforeader-frontend
2235

23-
Install the `npm` packages described in the `package.json` and verify that it works.
36+
# Go into the repository
37+
cd inforeader-frontend
2438

25-
```shell
39+
# Install dependencies
2640
npm install
27-
ng serve -o
41+
42+
# Run the app
43+
ng serve
2844
```
2945

30-
Shut it down manually with `Ctrl+C`
46+
shut it down manually with `Ctrl-C` or `Cmd-C`.
47+
48+
## 📐 Tests
3149

32-
## Environments
50+
```bash
51+
# Run tests
52+
npm run test
3353

34-
| Name | URL | PORT |
35-
| ---------- | ---------------------------------------- | ---- |
36-
| Localhost | [localhost](http://localhost:4200) | 4200 |
37-
| Production | [www.domain.com](https://www.domain.com) |
54+
# Run tests with coverage
55+
npm run test:cov
56+
```
57+
58+
## 🌎 Environments
59+
60+
| Name | URL | PORT |
61+
| ---------- | ----------------------------------------------------------------- | ---- |
62+
| Localhost | [localhost](http://localhost:4200) | 4200 |
63+
| Production | [https://inforeader.netlify.app/](https://inforeader.netlify.app/) |
3864

39-
## Folder Structure
65+
## 📁 Folder Structure
4066

4167
.
4268
├── src
@@ -59,16 +85,22 @@ Shut it down manually with `Ctrl+C`
5985
│ └── styles # Global styles
6086
└── README.md
6187

62-
## Previews
88+
## 📝 License
89+
90+
This project is under the [MIT](./LICENSE) license. See the LICENSE for more information. 😉
91+
92+
## 🖼️ Previews
93+
<details>
94+
<summary>Click to expand!</summary>
6395

64-
### Desktop
96+
### 🖥️ Desktop
6597

6698
![home-1](https://res.cloudinary.com/dfeujtobk/image/upload/v1658346332/InfoReader/home-1_gpqyqq.png)
6799
![home-2](https://res.cloudinary.com/dfeujtobk/image/upload/v1658346331/InfoReader/home-2_hpojr8.png)
68100
![home-3](https://res.cloudinary.com/dfeujtobk/image/upload/v1658346331/InfoReader/home-4_vqxco3.png)
69101
![home-4](https://res.cloudinary.com/dfeujtobk/image/upload/v1658346331/InfoReader/home-3_qqeh64.png)
70102

71-
### Mobile
103+
### 📱 Mobile
72104

73105
![mobile-1](https://res.cloudinary.com/dfeujtobk/image/upload/v1658346331/InfoReader/mobile-1_wjz51l.png)
74106
![mobile-2](https://res.cloudinary.com/dfeujtobk/image/upload/v1658346331/InfoReader/mobile-2_d7umlp.png)

0 commit comments

Comments
 (0)