From 39b7bad1008d8980b1a61289b21abff0fb4d1dcf Mon Sep 17 00:00:00 2001 From: Syndamia Date: Fri, 9 Apr 2021 18:35:48 +0300 Subject: Updated README --- README.md | 38 ++++++++++++++++++++++++-------------- 1 file changed, 24 insertions(+), 14 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 8ebb62a..996ed7e 100644 --- a/README.md +++ b/README.md @@ -1,27 +1,37 @@ -# Angular +# DevHive -This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 11.0.5. +DevHive is the social network solution for programmers. In it you can make posts to share with your friends, comment and more. -## Development server +This is the back-end portion of the project, built with [`Angular`](https://angular.io/). For the back-end, refer to [DevHive](https://github.com/Team-Kaleidoscope/DevHive). -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. +## Contents: +- [Setting up locally](#setting-up-locally) + - [Prerequisites](#prerequisites) + - [Starting up](#starting-up) + - [Important notes](#important-notes) +- [Screenshots](#screenshots) -## Code scaffolding +## Setting up locally -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`. +### Prerequisites -## Build +You'll need to install the following tools: +- [`Angular CLI 11.0.6`](https://www.tecmint.com/install-angular-cli-on-linux/) or greater (older versions might work, but haven't been tested) -Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory. Use the `--prod` flag for a production build. +### Starting up -## Running unit tests +1. Clone the repository: `git clone https://github.com/Team-Kaleidoscope/DevHive.git` +2. Navigate to the folder, in which you cloned it +3. Run `npm install` to install all front-end packages +4. Run `ng serve` to start up the front-end + - as with the API, you can [run the command in background](https://linuxize.com/post/how-to-run-linux-commands-in-background/) or [create a systemd service](https://medium.com/@benmorel/creating-a-linux-service-with-systemd-611b5c8b91d6) -Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io). +If everything went smoothly, you will be able to access the front-end from `http://localhost:4200`. Also, don't forget that the API needs to be running *at the same time*, otherwise you won't get beyond the Login and Register pages! -## Running end-to-end tests +### Important notes -Run `ng e2e` to execute the end-to-end tests via [Protractor](http://www.protractortest.org/). +If you host your API on a specific link that isn't the standard `http://localhost:5000`, go to `src/app` and edit the `app-constants.module.ts` file, on the second row you're gonna see the variable `BASE_API_URL`, update it. -## Further help +You can change on what port the front-end is ran, by issuing the serve command with the `--port` parameter: `ng serve --port 5001`. But, **don't run it with the `--ssl` parameter!** SSL isn't supported yet and you'll have issues trying to use it! If you really need ssl, using a [reverse proxy](https://www.cloudflare.com/learning/cdn/glossary/reverse-proxy/) might be a viable alternative. -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. +## Screenshots -- cgit v1.2.3 From 0111a04ad5d1d849784cf1839ef4d5964b36bf3a Mon Sep 17 00:00:00 2001 From: Syndamia Date: Fri, 9 Apr 2021 18:36:56 +0300 Subject: Added reference to docs in README --- README.md | 2 ++ 1 file changed, 2 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index 996ed7e..956ca9f 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,8 @@ DevHive is the social network solution for programmers. In it you can make posts This is the back-end portion of the project, built with [`Angular`](https://angular.io/). For the back-end, refer to [DevHive](https://github.com/Team-Kaleidoscope/DevHive). +In the `docs` folder you can find relevenat information and documentation about this project. You can also find our Privacy Policy. + ## Contents: - [Setting up locally](#setting-up-locally) - [Prerequisites](#prerequisites) -- cgit v1.2.3 From c13889759d70687de6833c505221c203f65fedb8 Mon Sep 17 00:00:00 2001 From: Syndamia Date: Fri, 9 Apr 2021 18:51:37 +0300 Subject: Added screenshots and added them in README --- README.md | 13 +++++++++++++ screenshots/comment-page-desktop.png | Bin 0 -> 36897 bytes screenshots/editing-comment-desktop.png | Bin 0 -> 19166 bytes screenshots/editing-post-desktop.png | Bin 0 -> 24190 bytes screenshots/feed-desktop.png | Bin 0 -> 71787 bytes screenshots/feed-mobile.png | Bin 0 -> 46709 bytes screenshots/login-desktop.png | Bin 0 -> 27202 bytes screenshots/login-mobile.png | Bin 0 -> 16120 bytes screenshots/post-page-desktop.png | Bin 0 -> 46746 bytes screenshots/profile-page-desktop.png | Bin 0 -> 54332 bytes screenshots/register-desktop.png | Bin 0 -> 29748 bytes screenshots/register-with-data-desktop.png | Bin 0 -> 27022 bytes screenshots/settings-page-desktop.png | Bin 0 -> 67187 bytes 13 files changed, 13 insertions(+) create mode 100644 screenshots/comment-page-desktop.png create mode 100644 screenshots/editing-comment-desktop.png create mode 100644 screenshots/editing-post-desktop.png create mode 100644 screenshots/feed-desktop.png create mode 100644 screenshots/feed-mobile.png create mode 100644 screenshots/login-desktop.png create mode 100644 screenshots/login-mobile.png create mode 100644 screenshots/post-page-desktop.png create mode 100644 screenshots/profile-page-desktop.png create mode 100644 screenshots/register-desktop.png create mode 100644 screenshots/register-with-data-desktop.png create mode 100644 screenshots/settings-page-desktop.png (limited to 'README.md') diff --git a/README.md b/README.md index 956ca9f..295725f 100644 --- a/README.md +++ b/README.md @@ -37,3 +37,16 @@ If you host your API on a specific link that isn't the standard `http://localhos You can change on what port the front-end is ran, by issuing the serve command with the `--port` parameter: `ng serve --port 5001`. But, **don't run it with the `--ssl` parameter!** SSL isn't supported yet and you'll have issues trying to use it! If you really need ssl, using a [reverse proxy](https://www.cloudflare.com/learning/cdn/glossary/reverse-proxy/) might be a viable alternative. ## Screenshots + +![](./screenshots/login-desktop.png) +![](./screenshots/login-mobile.png) +![](./screenshots/register-desktop.png) +![](./screenshots/register-with-data-desktop.png) +![](./screenshots/feed-desktop.png) +![](./screenshots/feed-mobile.png) +![](./screenshots/post-page-desktop.png) +![](./screenshots/comment-page-desktop.png) +![](./screenshots/editing-comment-desktop.png) +![](./screenshots/profile-page-desktop.png) +![](./screenshots/editing-post-desktop.png) +![](./screenshots/settings-page-desktop.png) diff --git a/screenshots/comment-page-desktop.png b/screenshots/comment-page-desktop.png new file mode 100644 index 0000000..a6d9091 Binary files /dev/null and b/screenshots/comment-page-desktop.png differ diff --git a/screenshots/editing-comment-desktop.png b/screenshots/editing-comment-desktop.png new file mode 100644 index 0000000..75cc672 Binary files /dev/null and b/screenshots/editing-comment-desktop.png differ diff --git a/screenshots/editing-post-desktop.png b/screenshots/editing-post-desktop.png new file mode 100644 index 0000000..7390144 Binary files /dev/null and b/screenshots/editing-post-desktop.png differ diff --git a/screenshots/feed-desktop.png b/screenshots/feed-desktop.png new file mode 100644 index 0000000..6f9267c Binary files /dev/null and b/screenshots/feed-desktop.png differ diff --git a/screenshots/feed-mobile.png b/screenshots/feed-mobile.png new file mode 100644 index 0000000..3db711b Binary files /dev/null and b/screenshots/feed-mobile.png differ diff --git a/screenshots/login-desktop.png b/screenshots/login-desktop.png new file mode 100644 index 0000000..ea3e436 Binary files /dev/null and b/screenshots/login-desktop.png differ diff --git a/screenshots/login-mobile.png b/screenshots/login-mobile.png new file mode 100644 index 0000000..30c8cf5 Binary files /dev/null and b/screenshots/login-mobile.png differ diff --git a/screenshots/post-page-desktop.png b/screenshots/post-page-desktop.png new file mode 100644 index 0000000..a65029b Binary files /dev/null and b/screenshots/post-page-desktop.png differ diff --git a/screenshots/profile-page-desktop.png b/screenshots/profile-page-desktop.png new file mode 100644 index 0000000..73f8066 Binary files /dev/null and b/screenshots/profile-page-desktop.png differ diff --git a/screenshots/register-desktop.png b/screenshots/register-desktop.png new file mode 100644 index 0000000..64f9159 Binary files /dev/null and b/screenshots/register-desktop.png differ diff --git a/screenshots/register-with-data-desktop.png b/screenshots/register-with-data-desktop.png new file mode 100644 index 0000000..3fd2e66 Binary files /dev/null and b/screenshots/register-with-data-desktop.png differ diff --git a/screenshots/settings-page-desktop.png b/screenshots/settings-page-desktop.png new file mode 100644 index 0000000..9880aef Binary files /dev/null and b/screenshots/settings-page-desktop.png differ -- cgit v1.2.3