Skip to content

Latest commit

 

History

History
112 lines (80 loc) · 3.61 KB

README.md

File metadata and controls

112 lines (80 loc) · 3.61 KB
Raw

CodeBin 📝💾

CodeBin is a private, handmade hastebin clone. It offers a convenient and secure way to store, share, and collaborate on code snippets with a community of fellow developers.

Preview

Preview

🌟 Features

  • 🔒 Private: Requires an account for access
  • 💻 Copy-Paste functionality for easy code sharing
  • 👥 Collaborate with others in real-time
  • 🌐 Accessible from any device with an internet connection
  • 📁 Organize your code snippets with custom folders and tags

🛠️ Built With

📚 Table of Contents

Getting Started 🚀

Follow these steps to get CodeBin up and running on your local machine.

Prerequisites 📋

Make sure you have the following software installed:

Installation ⚙️

  1. Clone the repository:
git clone https://github.com/TheNolle/CodeBin.git
  1. Navigate to the project directory:
cd CodeBin
  1. Install the required dependencies:
npm install

  1. Create a .env file in the root directory and configure it with your MongoDB connection string and other necessary variables. Refer to the .env.example file for guidance.

  2. Start the server:

npm start
  1. Access CodeBin in your browser at http://localhost:3000.

Usage 💻

  1. Register or log in to your CodeBin account.
  2. Create, edit, and save your code snippets.
  3. Share snippets with others by providing them with the unique URL.
  4. Organize your snippets with folders and tags for easy navigation.

Contributing 🤝

Please read our CONTRIBUTING for details on how to contribute to CodeBin.

Any contributions to CodeBin are greatly appreciated! If you'd like to help improve the project, please follow the steps outlined in the CONTRIBUTING file.

Code of Conduct 🌈

We strive to create a welcoming and inclusive community. By participating in this project, you agree to abide by our Code of Conduct. Please ensure that you treat everyone with respect and professionalism.

License 📄

This project is licensed under the MIT License. See the LICENSE file for more information.

Author 👨‍💻

Support ❤️

If you enjoy using CodeBin and want to support its development, consider becoming a patron or making a one-time donation. Your contributions will help keep the project alive and growing!

Thank you for your support! 💖🚀