README.md

Travel Log

An interactive Travel Log built with the Mapbox api.

Table of Contents

• Installation
• Usage
  • Development
  • Production
• Project Structure
• Contributing
• License

Installation

1. Clone the repository:

git clone https://github.com/ToddWebDev/travel-log-js.git
cd travel-log-js

2. Install the dependencies:

npm install

Usage

Development

To run the project locally for development purposes, use live-server:

npm run serve

This will start a local development server and open the project in your default web browser.

Ensure that your index.html file is using the script tag pointing to src/main.js:

<script type="module" src="src/main.js"></script> <!-- For development -->

Production

To build the project for production, use webpack:

npm run build

This will create a bundle.js file in the dist directory.

After building, update your index.html to use the bundle.js for production:

Project Structure

your-project/
├── dist/
│   └── bundle.js          # Built file for production
├── src/
│   ├── main.js            # Main JavaScript file
│   └── .js                # Other development modules
│   └── logsData.js        # Module containing logs data
├── index.html             # Main HTML file
├── package.json           # NPM package configuration
├── webpack.config.js      # Webpack configuration file
└── .babelrc               # Babel configuration file

Contributing

1.	Fork the repository.
2.	Create a new branch: git checkout -b my-feature-branch
3.	Make your changes and commit them: git commit -m 'Add some feature'
4.	Push to the branch: git push origin my-feature-branch
5.	Submit a pull request.

License

This project is licensed under the MIT License - see the LICENSE file for details.