EddieHubLive

EddieHubLive codebase

A map showing the location of all project contributors

Getting Started

This map shows contributions via websocket and you must be added to the EddieHub API to see your data on the map. Please keep reading for details on how to trigger data events to the map prior to beginning to work on any issues that are related to the data feed.

How to trigger new data to the feed

1. Open an issue in Support to be added to the API: Add me to the API
2. Start the project with npm or yarn if you have not already
3. In the EddieHubLive repository, edit an existing comment of yours to trigger a new github event which will show up in the map. You may edit as many times as you like to create more data. If you do not have any comments yet, you may add one and then edit for more data. Please do not add a new comment each time test data is required as this will create spam.

Navigate to directory on your machine:

cd folder/to/clone-into/

Clone repository:

git clone https://github.com/EddieHubCommunity/EddieHubLive

Navigate to repository:

cd ./EddieHubLive

Install the dependencies

npm i

Start the development Sever:

npm run dev

Build & production preview

npm run build && npm run preview

Project Structure

├── ...
├── components       Contains all page components (HOCs, elements, etc.)
├── Environments     Display events
├── App.js           Renders all component to create the page
└──......
──package.json     Contains all dependencies

Learn More About React, Socket.io and setting up and Leaflet.js

To learn more about Vue and Mongodb, take a look at the following resources:

• React Documentation - Learn about React and it's installation.
• Leaflet Documentation - Learn about Leaflet.js and it's usage
• Socket.io Documentation - Learn about Socket.io and it's usage

You can check out the React's GitHub repository - your feedback and contributions are welcome! You can check out the Leaflet's GitHub repository - your feedback and contributions are welcome! You can check out the Socket.io's GitHub repository - your feedback and contributions are welcome!

Our Pledge

We take participation in our community as a harassment-free experience for everyone and we pledge to act in ways to contribute to an open, welcoming, diverse and inclusive community.

If you have experienced or been made aware of unacceptable behaviour, please remember that you can report this. Read our Code of Conduct.