|
1 |
| -# Frontend |
| 1 | +# Cloud Box - A simple cloud storage service |
2 | 2 |
|
3 |
| -This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 13.2.2. |
| 3 | +This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 13.2.6 |
4 | 4 |
|
5 |
| -## Development server |
| 5 | +## Getting Started |
6 | 6 |
|
7 |
| -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. |
| 7 | +### Requirements |
8 | 8 |
|
9 |
| -## Code scaffolding |
| 9 | +- [Git](https://git-scm.com/downloads) |
| 10 | +- [NodeJs](https://nodejs.org/en/) |
| 11 | +- [Npm](https://www.npmjs.com/) |
| 12 | +- [Angular CLI](https://angular.io/cli) |
10 | 13 |
|
11 |
| -Run `ng generate component component-name` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module`. |
| 14 | +### Installation |
12 | 15 |
|
13 |
| -## Build |
| 16 | +#### Clone the repository |
14 | 17 |
|
15 |
| -Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory. |
| 18 | +```shell |
| 19 | +git clone |
| 20 | +https://github.com/marcode24/cloudbox-frontend |
| 21 | +``` |
16 | 22 |
|
17 |
| -## Running unit tests |
| 23 | +#### Check into the cloned repository |
18 | 24 |
|
19 |
| -Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io). |
| 25 | +```shell |
| 26 | +cd cloudbox-frontend |
| 27 | +``` |
20 | 28 |
|
21 |
| -## Running end-to-end tests |
| 29 | +#### Install dependencies |
22 | 30 |
|
23 |
| -Run `ng e2e` to execute the end-to-end tests via a platform of your choice. To use this command, you need to first add a package that implements end-to-end testing capabilities. |
| 31 | +```shell |
| 32 | +npm install |
| 33 | +``` |
24 | 34 |
|
25 |
| -## Further help |
| 35 | +#### Start the server |
26 | 36 |
|
27 |
| -To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI Overview and Command Reference](https://angular.io/cli) page. |
| 37 | +```shell |
| 38 | +ng serve |
| 39 | +``` |
| 40 | + |
| 41 | +#### Open the browser and navigate to |
| 42 | + |
| 43 | +```shell |
| 44 | +http://localhost:4200/ |
| 45 | +``` |
| 46 | + |
| 47 | +## Environments |
| 48 | + |
| 49 | +| Name | URL | PORT | |
| 50 | +| ---------- | ---------------------------------------- | ---- | |
| 51 | +| Localhost | [localhost](http://localhost:4200) | 4200 | |
| 52 | +| Production | [www.domain.com](https://www.domain.com) | |
| 53 | + |
| 54 | +## Folder Structure |
| 55 | + |
| 56 | + . |
| 57 | + ├── src |
| 58 | + │ ├── app # Source code application |
| 59 | + │ │ │── auth # Module for auth feature |
| 60 | + │ │ ├── core # Module as Singleton |
| 61 | + │ │ │ ├── components |
| 62 | + │ │ │ ├── enums |
| 63 | + │ │ │ ├── guards |
| 64 | + │ │ │ ├── interceptors |
| 65 | + │ │ │ ├── interfaces |
| 66 | + │ │ │ ├── models |
| 67 | + │ │ │ ├── services |
| 68 | + │ │ │ └── utils |
| 69 | + │ │ ├── features # Module for features which compose the application |
| 70 | + │ │ ├── shared # Module for components shared between application modules |
| 71 | + │ │ │ ├── components |
| 72 | + │ ├── assets # Styles, images, icons, fonts etc |
| 73 | + │ ├── environments # Config by environment (localhost and production) |
| 74 | + │ └── styles # Global styles |
| 75 | + └── README.md |
| 76 | + |
| 77 | +## Previews - Desktop |
| 78 | + |
| 79 | +### Login |
| 80 | + |
| 81 | + |
| 82 | + |
| 83 | +### Register |
| 84 | + |
| 85 | + |
| 86 | + |
| 87 | +### Home |
| 88 | + |
| 89 | + |
| 90 | + |
| 91 | +## Previews - Mobile |
| 92 | + |
| 93 | +### Login |
| 94 | + |
| 95 | + |
| 96 | + |
| 97 | +### Register |
| 98 | + |
| 99 | + |
| 100 | + |
| 101 | +### Home |
| 102 | + |
| 103 | + |
0 commit comments