🗺 TravelMap App

TravelMap is an educational app where you can save your routes, pin waypoints in some places and rate it adding own comments.

Basic Features 📸

This app has the following features, used for practice:

• Login and Register (coming soon)
• Create Waypoints (coming soon)
• Add names and descriptions of this Waypoints (coming soon)
• Create Routes between two Waypoints (coming soon)

Getting Started 🎈

• Clone this repository

  git clone https://github.com/alexisg24/travelmap-app

Create a .env file based in .env.example and fill the variables with necesarie info (using a PostgreSQL DB)

• Install necesaries dependencies

npm install

• Run in development mode

npm run dev

• Run in production build First we need build the project using:

npm run build

Then a dist dir will be generated with transpiled project. Now can use:

npm run start

#or

node ./dist/index.js

If you want use docker images

• Open docker and run the containers

docker-composer up -d

API Documentation and Endpoints

• Access to the route:

{{base_url}}/api/v1/docs

Author 🙋‍♂️

• @alexisg24

License ⚖

MIT