https://github.com/prantoshb/snippit
Snipit is a platform for developers to share code snippets, find inspiration, and learn new techniques from fellow coders.
https://github.com/prantoshb/snippit
Last synced: about 2 months ago
JSON representation
Snipit is a platform for developers to share code snippets, find inspiration, and learn new techniques from fellow coders.
- Host: GitHub
- URL: https://github.com/prantoshb/snippit
- Owner: PrantoshB
- License: mit
- Created: 2023-04-22T08:29:11.000Z (about 3 years ago)
- Default Branch: dev
- Last Pushed: 2023-08-06T16:43:25.000Z (almost 3 years ago)
- Last Synced: 2025-12-31T08:21:05.184Z (6 months ago)
- Language: Ruby
- Homepage:
- Size: 2.58 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[](https://github.com/PrantoshB/Snippit/graphs/contributors)
[](https://github.com/PrantoshB/Snippit/commits/dev)
[](https://github.com/PrantoshB/Snippit/stargazers)
[](https://github.com/PrantoshB/Snippit/issues)
[](https://github.com/PrantoshB/Snippit/blob/main/LICENSE)
[](https://github.com/PrantoshB/Snippit/pulls?q=is%3Amerged)
[](https://github.com/ellerbrock/open-source-badges/)
Table of Contents
- [💻 About Snippit](#-about-snippit)
- [✨ Features](#-features)
- [🧰 Tech Stack](#-tech-stack)
- [📘 Getting Started](#-getting-started)
- [📋 Prerequisites](#-prerequisites)
- [📂 Setup](#-setup)
- [📥 Installation](#-installation)
- [💾 Database](#-database)
- [💻 Usage](#-usage)
- [🧪 Run tests](#-run-tests)
- [🎯 Future Features](#-future-features)
- [🤝 Contributing](#-contributing)
- [👨🚀 Contributors](#-contributors)
- [💖 Show Your Support](#-show-your-support)
- [📜 License](#-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.
## ✨ 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.
## 🧰 Tech Stack
- **Ruby on Rails**
- **PostgreSQL**
- **ERB (Embedded Ruby)**
- **Devise Gem**
## 📘 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](https://www.ruby-lang.org/en/)
- [Rails 7.0.4 or higher](https://rubyonrails.org/)
- [PostgreSQL 15.2 or higher](https://www.postgresql.org/)
### 📂 Setup
Clone this repository to your desired foler.
```sh
cd my-project
git clone git@github.com:PrantoshB/Snippit.git .
```
### 📥 Installation
Intall this project with:
```sh
bundle install
```
### 💾 Database
Create the databases and run migrations with:
```sh
rails db:create
rails db:migrate
```
### 💻 Usage
To run the project, execute the following command:
```sh
rails server
```
### 🧪 Run tests
To run tests, run the following command:
```sh
rspec spec
```
## 🎯 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.
## 🤝 Contributing
We welcome contributions from the community!
If you'd like to contribute to the project, please follow the guidelines outlined in [CONTRIBUTING.md](./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](https://github.com/PrantoshB/Snippit/issues) page. We'll do our best to address them.
## 👨🚀 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** | [](https://github.com/PrantoshB) [](https://linkedin.com/in/prantosh) [](mailto:pbiswas1007@gmail.com) |
| **Hein Thant** | [](https://github.com/IndieCoderMM) [](https://linkedin.com/in/hthantoo) [](mailto:hthant00chk@gmail.com) |
## 💖 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.
## 📜 License
This project is licensed under the [MIT License](./LICENSE).