Skip to content

Latest commit

 

History

History
80 lines (57 loc) · 2.61 KB

README.md

File metadata and controls

80 lines (57 loc) · 2.61 KB
Raw

Travel Log

A full stack application to store/list places you have traveled (based on Node.js, React, MongoDB and Mapbox).

TODO

  • Setup Server
    • Install Dependencies
    • Install / Setup Linter
    • Setup Express App
    • Setup Not Found and Error Middlewares
  • Model DB
    • What data will we store?
  • Setup Mongoose Model(s)
  • POST /logs
    • Create a new log entry
  • GET / logs
    • List all log entries
  • Setup Client
  • Create Form to add a new entry
  • Setup Map SDK on client
  • List all log entries on map
  • DEPLOY!

How to run code

Installation

git clone https://github.com/hamza1886/travel-log.git
cd ./server && npm install
cd ./client && npm install

Development

cd ./server && npm run dev
cd ./client && npm run start

Deployment

To run server (back-end)

cd ./server
cp .env.example .env
npm run start

To run client (front-end)

cd ./client
cp .env.example .env
npm run build
serve -s -l 3000 build

Here, port 3000 corresponds with CORS_ORIGIN=http://localhost:3000 in file ./server/.env.
In file ./client/.env, to obtain REACT_APP_MAPBOX_TOKEN visit https://docs.mapbox.com/mapbox-gl-js/api/

Changes

See CHANGELOG

Contribute

Please do contribute! Issues and pull requests are welcome.

License

Copyright (c) 2020 Hamza Rashid

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.