Free Walking

This repository implements the backend side of the project Free Walking, that aims to provide a new platform to people that desire sharing personal routes during a travel. This repository will contain a pool of functionalities and endpoints, each of them, when implemented, will be specified here.

Stack

node (10.10.0)
PostgreSQL (10.5)
knex.js (0.15.2)
mocha.js (5.2.0)
lint(5.5.0)
npm (6.4.1)

Cards

Each card contais information about the place visited by the user and stores them.

End points

Method	URL	Description
GET	/api/cards/	Get all cards in database
GET	/api/cards/<id>	Get a cards with <id>
POST	/api/cards/	Insert one card in database
PUT	/api/cards/<id>	Updates a specific card with <id>
DELETE	/api/cards/<id>	Delete a specific card with <id>

The POST requisition require the following JSON formmat:

{
	"title": "João Pessoa",
	"description": "City of Paraíba state",
	"latitude": -7.115,
	"longitude": -34.86306,
	"hashtags": ["#city", "#home", "#sun"]
}

The PUT requisition require the following JSON formmat:

{
	"title": "João Pessoa",
	"description": "City of Paraíba state",
	"latitude": -7.115,
	"longitude": -34.86306,
	"hashtags": ["#city", "#home", "#sun"]
}

Installation

Install all necessary modules to run the current project.

$ git clone https://github.com/alvesfelipe/free-walking
$ cd free-walking
$ npm install

The installation command above already executes npm run build, that creates free_walking database and tables.

Development

$ cd free-walking
$ npm run dev

Tested on MacBook Pro device, using the OS X El Capitan Version 10.11.6.

Tests

In order to create a test database, tables and seed, type:

$ cd free-walking
$ npm test

Contributors

Felipe Alves (alvesfelipe)