Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shuvra-matrix/code-carbon
Live Demo
https://github.com/shuvra-matrix/code-carbon
carbon code codeshare nodejs share shared
Last synced: 3 days ago
JSON representation
Live Demo
- Host: GitHub
- URL: https://github.com/shuvra-matrix/code-carbon
- Owner: shuvra-matrix
- Created: 2023-06-25T07:59:43.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-07-18T21:55:51.000Z (over 1 year ago)
- Last Synced: 2024-11-06T20:33:45.730Z (about 2 months ago)
- Topics: carbon, code, codeshare, nodejs, share, shared
- Language: JavaScript
- Homepage: https://code-carbon.onrender.com/
- Size: 152 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# :notebook_with_decorative_cover: Table of Contents
- [About the Project](#star2-about-the-project)
- [Live Demo](#house-livedemo)
- [Tech Stack](#space_invader-tech-stack)
- [Features](#dart-features)
- [Environment Variables](#key-environment-variables)
- [Getting Started](#toolbox-getting-started)
- [Prerequisites](#bangbang-prerequisites)
- [Run Locally](#running-run-locally)
- [To-do](#notes-to-do)
- [Contributing](#wave-contributing)
- [License](#warning-license)
- [Contact](#handshake-contact)
- [Acknowledgements](#gem-acknowledgements)
## :star2: 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!
### :house: LiveDemo
[Live Demo](https://code-carbon.onrender.com/)
### :space_invader: Tech Stack
Frontend
Backend
Database
### :dart: 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
### :key: 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`
## :toolbox: Getting Started
### :bangbang: Prerequisites
This project uses MongoDB as database. please install mongodb server in local environment.
### :running: Run Locally
Clone the project
```bash
git clone https://github.com/shuvra-matrix/CODE-CARBON
```
Go to the project directory
```bash
cd project-directory
```
Install dependencies
```bash
npm install
```
Start the backend server
```bash
npm run dev
```
Use following paths
```bash
Backend server : localhost:3000/
```
## :notes: to-do
- add more features
## :wave: Contributing
Contributions are always welcome!
## :warning: License
Distributed under the no License.
## :handshake: Contact
Shuvra Chakrabarty -
Project Link: [https://github.com/shuvra-matrix/CODE-CARBON](https://github.com/shuvra-matrix/CODE-CARBON)
## :gem: Acknowledgements
Following libraries have been used in this projects.
- [highlight.js](https://highlightjs.org/)
- [express-validator](https://express-validator.github.io/docs/)
- [connect-mongodb-session](https://www.npmjs.com/package/connect-mongodb-session)