Code Carbon

View Demo · Report Bug · Request Feature

📔 Table of Contents

• About the Project
  • Live Demo
  • Tech Stack
  • Features
  • Environment Variables
• Getting Started
  • Prerequisites
  • Run Locally
• To-do
• Contributing
• License
• Contact
• Acknowledgements

🌟 About the Project

Code Carbon is a powerful and versatile web app that allows users to easily share their code in image format. With support for all types of programming languages, users can showcase their skills and share their work with friends, colleagues, and the wider programming community with ease.

With Code Carbon, users have complete control over the look and feel of their code, with the ability to change the code theme and color dynamically. Whether you prefer a dark or light mode, or a transparent background for your images, Code Carbon makes it easy to customize your code to your preferences.

Overall, Code Carbon is the perfect tool for programmers, developers, and anyone who wants to share their code with the world in a beautiful and professional way. With its intuitive interface and advanced features, Code Carbon is sure to become a go-to platform for coders everywhere!

🏠 LiveDemo

Live Demo

👾 Tech Stack

Frontend

• HTML 5
• CSS 3
• JavaScript
• highlight.js

Backend

• Node.js
• Express.js
• Mongoos
• Express-session

Database

• MongoDB

🎯 Features

• User
  • Support for all types of programming languages
  • Easy sharing of code in image format
  • Dynamic code theme and color customization options
  • Dark mode and light mode options
  • Transparent background image option
  • Intuitive interface for easy code sharing
  • Professional and polished code image output
  • Easy editing and updating of code images
  • Secure storage and sharing of code images

🔑 Environment Variables

To run this project, you will need to add the following variables to your .env file

MONGO_USER = MONGO DB USE NAME MONGO_PASS = MONGODB PASSWORD SESSION SECRET = SESSION SECRET MONGO_DB_NAME = YOUR MONGO DB NAME

🧰 Getting Started

‼️ Prerequisites

This project uses MongoDB as database. please install mongodb server in local environment.

🏃 Run Locally

Clone the project

  git clone https://github.com/shuvra-matrix/CODE-CARBON

Go to the project directory

  cd project-directory

Install dependencies

  npm install

Start the backend server

  npm run dev

Use following paths

  Backend server : localhost:3000/

🎶 to-do

• add more features

👋 Contributing

Contributions are always welcome!

⚠️ License

Distributed under the no License.

🤝 Contact

Shuvra Chakrabarty - shuvrachakrabarty97@gmail.com

Project Link: https://github.com/shuvra-matrix/CODE-CARBON

💎 Acknowledgements

Following libraries have been used in this projects.

• highlight.js
• express-validator
• connect-mongodb-session