Code Monkey home page Code Monkey logo

travelmap-app's Introduction

๐Ÿ—บ 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 ๐ŸŽˆ

  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 ๐Ÿ™‹โ€โ™‚๏ธ

License โš–

MIT

travelmap-app's People

Contributors

alexisg24 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

Forkers

maurox28363429

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.