Trendboard

Trendboard is a web application that visualizes real-time, trendy public datasets through interactive charts and dashboards. Built using modern technologies like React, Vite, and Recharts, this app provides an insightful way to explore datasets like layoffs, stock data, and more.

Features

• Interactive data visualizations using charts
• Filterable datasets for easy analysis
• Responsive layout using Tailwind CSS for a modern look

Tech Stack

• Frontend: React, Vite, TypeScript, Recharts, Tailwind CSS
• API: Airtable (or static CSV files)
• Deployment: GitHub Pages

Installation

To run the project locally, follow these steps:

1. Clone the repository:

   git clone https://github.com/data-insider-nyc/trendboard
   cd trendboard

2. Install the dependencies:

   npm install

3. Run the development server:

   npm run dev

   This will start the app at http://localhost:5173.

Build and Deployment

To build the app for production and deploy it, follow these steps:

1. Build the project:

   npm run build

   This will generate a dist folder containing the optimized production build.

2. Deploy to GitHub Pages:

   npm run deploy

   This will push the latest build to the gh-pages branch and deploy it to GitHub Pages.

Development

1. Run Locally: To run the app locally for development, you can use the npm run dev command. This will start a development server with hot-reloading.

2. Make Changes: Edit the components, data files, and styles as needed.

3. Linting: To run linting on your code, use the following command:

   npm run lint

4. Create a Pull Request: When you're done making changes, push them to your branch and open a pull request to merge them into the main branch.

Contributing

Feel free to fork the repository, make changes, and open pull requests. Contributions are always welcome!

License

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