CarbonTrack 1 is a sleek web application designed to track and visualize CO₂ emissions in real-time. Built with modern web technologies and deployed on Vercel, CarbonTrack 1 helps you gain insights into environmental data with an interactive and responsive interface.
- Features
- Tech Stack
- Live Demo
- Installation
- Usage
- Project Structure
- Contributing
- License
- Acknowledgements
- Real-Time Data Visualization: Enjoy interactive charts and graphs that update in real time.
- Responsive Design: Optimized for desktops, tablets, and mobile devices.
- Clean User Interface: An intuitive UI that makes exploring data a breeze.
- Interactive Components: Engaging UI elements for deeper insights into environmental metrics.
- Open Source: Fully transparent code available on GitHub for contributions and customizations.
- Frontend: React (or Next.js) for a dynamic and performant UI.
- Backend/API: Serverless functions and API integrations for real-time data.
- Styling: Modern CSS frameworks and libraries to keep your code clean and scalable.
- Deployment: Hosted on Vercel for seamless CI/CD and global delivery.
Check out the live demo of CarbonTrack 1:
https://carbontrack1.vercel.app
Follow these steps to run CarbonTrack 1 locally:
-
Clone the Repository:
```bash git clone https://github.com/THE-DEEPDAS/carbontrack_1.git cd carbontrack_1 ```
-
Install Dependencies:
Using npm: ```bash npm install ``` Or with Yarn: ```bash yarn install ```
-
Setup Environment Variables:
Create a `.env.local` file in the root directory and add any necessary variables. Refer to the repository documentation for details.
To start the development server:
```bash npm run dev
yarn dev ```
Open http://localhost:3000 in your browser to view the application.
Build and start the application in production mode:
```bash npm run build npm run start
yarn build yarn start ```
An overview of the project structure:
``` carbontrack_1/ ├── components/ # Reusable React components ├── pages/ # Page components (for Next.js or similar frameworks) │ └── index.js # Main landing page ├── public/ # Static assets (images, fonts, etc.) ├── styles/ # Global and component-specific styles ├── utils/ # Utility functions and helpers ├── .env.example # Example configuration file for environment variables ├── package.json # Project metadata and dependencies └── README.md # This file ```
Contributions are welcome! To contribute:
-
Fork the repository.
-
Create a new branch:
```bash git checkout -b feature/your-feature-name ```
-
Commit your changes:
```bash git commit -m "Add new feature or fix bug" ```
-
Push to your branch:
```bash git push origin feature/your-feature-name ```
-
Open a Pull Request on GitHub.
For major changes, please open an issue first to discuss your ideas.
This project is licensed under the MIT License. See the LICENSE file for details.
- Vercel for hosting and deployment.
- The open-source community for the tools and libraries that made this project possible.
- Environmental data providers and initiatives like Our World in Data for inspiring the project.
Happy coding, and let's work together to track and reduce carbon emissions!`;
// Convert the content to Base64
const base64Content = btoa(unescape(encodeURIComponent(readmeContent)));
// Set the href attribute to the data URL with the encoded content
document.getElementById('download-link').href = 'data:text/markdown;charset=utf-8;base64,' + base64Content;
</script>