|
1 | | -# RssAngular |
2 | | - |
3 | | -This project was generated using [Angular CLI](https://github.com/angular/angular-cli) version 20.0.2. |
4 | | - |
5 | | -## Development server |
6 | | - |
7 | | -To start a local development server, run: |
8 | | - |
9 | | -```bash |
10 | | -ng serve |
11 | | -``` |
12 | | - |
13 | | -Once the server is running, open your browser and navigate to `http://localhost:4200/`. The application will automatically reload whenever you modify any of the source files. |
14 | | - |
15 | | -## Code scaffolding |
16 | | - |
17 | | -Angular CLI includes powerful code scaffolding tools. To generate a new component, run: |
18 | | - |
19 | | -```bash |
20 | | -ng generate component component-name |
21 | | -``` |
22 | | - |
23 | | -For a complete list of available schematics (such as `components`, `directives`, or `pipes`), run: |
24 | | - |
25 | | -```bash |
26 | | -ng generate --help |
27 | | -``` |
28 | | - |
29 | | -## Building |
30 | | - |
31 | | -To build the project run: |
32 | | - |
33 | | -```bash |
34 | | -ng build |
35 | | -``` |
36 | | - |
37 | | -This will compile your project and store the build artifacts in the `dist/` directory. By default, the production build optimizes your application for performance and speed. |
38 | | - |
39 | | -## Running unit tests |
40 | | - |
41 | | -To execute unit tests with the [Karma](https://karma-runner.github.io) test runner, use the following command: |
42 | | - |
43 | | -```bash |
44 | | -ng test |
45 | | -``` |
46 | | - |
47 | | -## Running end-to-end tests |
48 | | - |
49 | | -For end-to-end (e2e) testing, run: |
50 | | - |
51 | | -```bash |
52 | | -ng e2e |
53 | | -``` |
54 | | - |
55 | | -Angular CLI does not come with an end-to-end testing framework by default. You can choose one that suits your needs. |
56 | | - |
57 | | -## Additional Resources |
58 | | - |
59 | | -For more information on using the Angular CLI, including detailed command references, visit the [Angular CLI Overview and Command Reference](https://angular.dev/tools/cli) page. |
| 1 | +# RSS reading app client |
| 2 | + |
| 3 | +Client for the [RSS app](https://github.com/emp74ark/rss-nest) built with Angular 20 and Angular Material. |
| 4 | + |
| 5 | +## Tech stack |
| 6 | +- Angular 20 |
| 7 | +- Angular Material |
| 8 | + |
| 9 | +## Prerequisites |
| 10 | +- Node.js 20+ (Node 22 used in Dockerfile) |
| 11 | +- npm 9+ |
| 12 | +- Angular CLI 20 globally installed (optional): |
| 13 | + ```bash |
| 14 | + npm i -g @angular/cli@20 |
| 15 | + ``` |
| 16 | +- Backend: [Repository](https://github.com/emp74ark/rss-nest) |
| 17 | + |
| 18 | +## Getting started (local development) |
| 19 | +1. Install dependencies: |
| 20 | + ```bash |
| 21 | + npm install |
| 22 | + ``` |
| 23 | +2. Start the dev server: |
| 24 | + ```bash |
| 25 | + npm start |
| 26 | + # or |
| 27 | + ng serve |
| 28 | + ``` |
| 29 | +3. Open http://localhost:4200 |
| 30 | + |
| 31 | + |
| 32 | +## Deploy |
| 33 | + |
| 34 | +Using docker compose: [repository](https://github.com/emp74ark/rss-deploy) |
| 35 | + |
| 36 | +## Project structure (high level) |
| 37 | +- `src/app/pages` — feature pages: auth, articles, bookmarks, feeds, tags, user, status |
| 38 | +- `src/app/components` — reusable components: article list, paginator, dialogs, forms |
| 39 | +- `src/app/services` — API services (auth, feed, tag, user, page, title) |
| 40 | +- `src/environments` — environment configs (`development` and `production`) |
| 41 | + |
| 42 | +## License |
| 43 | +ISC (see package.json) |
0 commit comments