pebbletor

KO | EN

gitlite — search

#javascript #python #hacktoberfest #ai #golang #go #machine-learning #linux #docker #macos #kubernetes #awesome-list #pytorch #openai

(★ 9)

A MERN stack application used to create hill charts with live collaboration using web sockets.

pebbletor Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![LinkedIn][linkedin-shield]][linkedin-url]

<br />
<div align="center">
  <a href="https://github.com/erohs/pebbletor">
    <img src="images/logo.png" alt="Logo" width="80" height="80">
  </a>

<h3 align="center">Pebbletor</h3>

<p align="center">
    A MERN stack application used to create hill charts with live collaboration using web sockets. 
    <br />
    <a href="https://github.com/erohs/pebbletor"><strong>Explore the docs »</strong></a>
    <br />
    <br />
    <a href="https://pebbletor.netlify.app/">View Demo</a>
    ·
    <a href="https://github.com/erohs/pebbletor/issues">Report Bug</a>
    ·
    <a href="https://github.com/erohs/pebbletor/issues">Request Feature</a>
  </p>
</div>

<details>
  <summary>Table of Contents</summary>
  <ol>
    <li>
      <a href="#about-the-project">About The Project</a>
      <ul>
        <li><a href="#built-with">Built With</a></li>
      </ul>
    </li>
    <li>
      <a href="#getting-started">Getting Started</a>
      <ul>
        <li><a href="#prerequisites">Prerequisites</a></li>
        <li><a href="#installation">Installation</a></li>
      </ul>
    </li>
    <li><a href="#roadmap">Roadmap</a></li>
    <li><a href="#contributing">Contributing</a></li>
    <li><a href="#contact">Contact</a></li>
    <li><a href="#acknowledgments">Acknowledgments</a></li>
  </ol>
</details>

## About The Project

[![Pebbletor Screenshot Light Mode][product-screenshot-1]](https://pebbletor.netlify.app/)

Our team had recently switched to creating hill charts as a means of better visualising project progression. These hill charts were created using [Miro](https://miro.com/), which meant team effort had to go into creating, maintaining and updating these charts. Pebbletor is my way of speeding up this process by separating what we had into a standalone app.
Pebbletor will take everything that we enjoyed about using Miro:

* Cusomisation 
* Ease of access
* Live collaboration

And expand upon it, bringing much more value to us whilst being less of a time sink for the development team. It will provide a platform for expansion into <a href="#roadmap">valuable features</a>

### Built With

* [Mongoose.js](https://mongoosejs.com/)
* [Express.js](https://expressjs.com/)
* [React.js](https://reactjs.org/)
* [Node.js](https://nodejs.org/en/)
* [D3.js](https://d3js.org/)
* [Socket.io](https://socket.io/)
* [Axios](https://axios-http.com/)
* [Typescript](https://www.typescriptlang.org/)

## Getting Started

### Prerequisites

* git
* npm
  ```sh
  npm install -g npm@latest 
  npm install -g nodemon
  ```

### Installation

1. Get mongoDB Atlas free at [https://www.mongodb.com/](https://www.mongodb.com/)
2. Clone the repo
   ```sh
   git clone https://github.com/erohs/pebbletor.git
   ```
3. Install NPM packages in the client and server folder
   ```sh
   npm install
   ```
4. Enter your MongoDB Atlas URI in `.env` within the server folder
   ```js
   ATLAS_URI='ENTER YOUR URI';
   ```
   or for local development
   ```js
   ATLAS_URI='mongodb://localhost:27017/hillchart';
   ```
5. Change the baseUrl within `index.ts` within the client api folder
   ```js
   const baseUrl = 'ENTER SERVER DEPLOYMENT URL';
   ```
   or for local development
   ```js
   const baseUrl = 'http://localhost:5000';
   ```
6. Start your server from the server folder or run your backend deployment
   ```sh
   nodemon server.js
   ```
7. Start the client or run your front end deployment
   ```sh
   npm start
   ```

## Roadmap

- [ ] Custom images
    - [ ] Marker images
    - [ ] Hill Chart background
- [ ] User accounts
- [ ] Stat tracking
    - [x] Marker history system
    - [ ] Reporting on stats
- [ ] Jira integration
    - [ ] Sync issues from epic
    - [ ] Place synced issue onto chart
- [ ] Copy chart as PNG (Default Styling)
- [ ] Daily / Weekly objectives

See the [open issues](https://github.com/erohs/pebbletor/issues) for a full list of proposed features (and known issues).

## Contact

Naomi Shore

Project Link: [https://github.com/erohs/pebbletor](https://github.com/erohs/pebbletor)

## Acknowledgments

* [freeCodeCamp MERN Stack Tutorial](https://www.youtube.com/watch?v=ngc9gnGgUdA&t)
* [Basecamp Hill Charts](https://basecamp.com/features/hill-charts)
* [README Template](https://github.com/othneildrew/Best-README-Template)

[contributors-shield]: https://img.shields.io/github/contributors/erohs/pebbletor.svg?style=for-the-badge
[contributors-url]: https://github.com/erohs/pebbletor/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/erohs/pebbletor.svg?style=for-the-badge
[forks-url]: https://github.com/erohs/pebbletor/network/members
[stars-shield]: https://img.shields.io/github/stars/erohs/pebbletor.svg?style=for-the-badge
[stars-url]: https://github.com/erohs/pebbletor/stargazers
[issues-shield]: https://img.shields.io/github/issues/erohs/pebbletor.svg?style=for-the-badge
[issues-url]: https://github.com/erohs/pebbletor/issues
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
[linkedin-url]: https://linkedin.com/in/jacob-shore-a0101a199
[product-screenshot-1]: images/PebbletorHillChartLight.png
[product-screenshot-2]: images/PebbletorHillChartDark.png

pebbletor

pebbletor Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

pebbletor

pebbletor Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README