Table of Contents

• 💻 About Snippit
  • ✨ Features
  • 🧰 Tech Stack
  • 📘 Getting Started
    • 📋 Prerequisites
    • 📂 Setup
    • 📥 Installation
    • 💾 Database
    • 💻 Usage
    • 🧪 Run tests
  • 🎯 Future Features
  • 🤝 Contributing
  • 👨‍🚀 Contributors
  • 💖 Show Your Support
  • 📜 License

💻 About Snippit

Community-driven code sharing platform

Snippit is an open-source code sharing website that allows developers to share code snippets, receive feedback, and collaborate with others. It aims to provide a platform for the community to learn, inspire, and improve their coding skills.

(back to top)

✨ Features

• Code Snippet Sharing: Easily share your code snippets with others.
• Feedback and Comments: Receive feedback and comments from the community on your code snippets.
• Like and Save Snippets: Like and save snippets to easily access them later.
• Syntax Highlighting: Code snippets are displayed with syntax highlighting for better readability.

(back to top)

🧰 Tech Stack

• Ruby on Rails
• PostgreSQL
• ERB (Embedded Ruby)
• Devise Gem

(back to top)

📘 Getting Started

To run this project locally, follow these steps.

📋 Prerequisites

Make sure you have the following installed on your machine:

• Ruby 3.2.1 or higher
• Rails 7.0.4 or higher
• PostgreSQL 15.2 or higher

📂 Setup

Clone this repository to your desired foler.

cd my-project
git clone git@github.com:PrantoshB/Snippit.git .

📥 Installation

Intall this project with:

bundle install

💾 Database

Create the databases and run migrations with:

rails db:create
rails db:migrate

💻 Usage

To run the project, execute the following command:

rails server

🧪 Run tests

To run tests, run the following command:

rspec spec

(back to top)

🎯 Future Features

• User Profiles: Create a user profile to showcase your shared snippets and interact with other users.
• Search Functionality: Search for code snippets based on keywords, tags, or programming languages.
• Tags and Categories: Organize snippets with tags and categories for easy discoverability.

(back to top)

🤝 Contributing

We welcome contributions from the community!

If you'd like to contribute to the project, please follow the guidelines outlined in CONTRIBUTING.md. We appreciate your help!

If you encounter any issues, have feature requests, or want to report a bug, please open an issue on the Issues page. We'll do our best to address them.

(back to top)

👨‍🚀 Contributors

We are always looking for ways to improve this project. If you have any suggestions or ideas, we would love to hear from you.

Name	Socials
Prantosh Biswas
Hein Thant

(back to top)

💖 Show Your Support

If you find this project useful or interesting, please consider giving it a star ⭐️. It helps us gain visibility and encourages us to continue improving and adding new features.

(back to top)

📜 License

This project is licensed under the MIT License.

(back to top)