dicearr / praw

Tourists, restaurants, reviews and so on

praw

Tourists, restaurants, reviews and so on

Dependencies

Some software is required in order to run the application:

1. Yarn to manage Node packages.
2. MongoDB to store the new reviews.

Deployment

Before launching the application you will need to install all the dependencies and compile the Angular application itself. There is a build script prepared for this.

$ yarn build

Usage

Once you have built the application you can launch it by running:

$ yarn start

This will allow to access to the webpage in http://localhost. If you don't want to launch the application locally you can deploy it to Heroku. By the way, to acomplish with continuous deployment principle this application is deployed with every commit (successfully tested) in

Documentation

• The REST API has been documented using Swagger. It is available on http://localhost/api or https://praw.herokuapp.com/api
• Technical documentation about the frontend can be found in docs folder. It has been generated using Compodoc.

Technology

All the backend has been developed on top of NodeJS. I have used several node packages.

• express - For the web server itself
• helmet - Adds security to express
• resourcejs - Allows you to build a REST API easy
• mongoose - To connect with MongoDB

The frontend has been developed using Angular.

• @agm/core - To integrate Google places/map API
• angular-star-rating - To rate with stars