Updated README

1 files changed, 24 insertions, 14 deletions

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