Skip to content

SulemanMughal/code-sharing

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Code Sharing Application

A Django-based web application that enables developers to share, organize, and manage code snippets efficiently. The platform is designed with productivity and collaboration in mind, offering robust features for storing, searching, and interacting with code examples.

Features

  • User Authentication: Secure registration and login system for managing personal code snippets.
  • Code Snippet Management: Create, edit, and delete code snippets with metadata such as language, tags, and descriptions.
  • Syntax Highlighting: Supports multiple programming languages with syntax highlighting for enhanced readability.
  • Search and Filter: Quickly search and filter snippets by title, tags, language, and author.
  • Bookmarks: Bookmark favorite snippets for easy access.
  • Rating System: Mark snippets as useful or not useful to help surface high-quality content.
  • Responsive Design: Fully accessible on desktop and mobile devices.
  • Author and Language Browsing: Browse snippets by language or author for topical exploration.

Technologies Used

  • Backend: Django (Python)
  • Frontend: HTML, CSS (Bootstrap), JavaScript
  • Database: SQLite (default, easily configurable to other databases)
  • Syntax Highlighting: Pygments

Installation

  1. Clone the repository:

    git clone https://github.com/SulemanMughal/code-sharing.git
    cd code-sharing
  2. Install dependencies:

    pip install -r requirements.txt
  3. Apply migrations:

    python manage.py migrate
  4. Create a superuser:

    python manage.py createsuperuser
  5. Run the development server:

    python manage.py runserver
  6. Access the application: Open your browser and visit http://127.0.0.1:8000/.

Usage

  • Register or log in to start creating and managing your code snippets.
  • Use the navigation bar to view all snippets, browse by language, author, or manage your bookmarks.
  • Add new snippets with syntax highlighting and descriptive tags.
  • Bookmark and rate snippets to curate and promote useful code for the community.

Contributing

Contributions are welcome! Please fork the repository, create a feature branch, make your changes, and submit a pull request.

  1. Fork the repository
  2. Create your feature branch: git checkout -b feature/YourFeature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin feature/YourFeature
  5. Open a pull request

License

This project is licensed under the MIT License.

Contact

For any questions or feedback, please open an issue or contact SulemanMughal.

About

Enables developers to share, organize, and manage code snippets efficiently.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published