{"id":24277118,"url":"https://github.com/indiecodermm/snippit-ui","last_synced_at":"2025-04-13T05:53:52.513Z","repository":{"id":181470360,"uuid":"666521233","full_name":"IndieCoderMM/snippit-ui","owner":"IndieCoderMM","description":"✨Snippit: Code-sharing platform to learn, explore and innovate together | Front End Repo | React, Redux, RoR, Postgres","archived":false,"fork":false,"pushed_at":"2023-09-25T10:47:43.000Z","size":347,"stargazers_count":3,"open_issues_count":14,"forks_count":1,"subscribers_count":2,"default_branch":"dev","last_synced_at":"2025-04-13T05:53:46.656Z","etag":null,"topics":["code-sharing-platform","collaborate","communityexchange","open-source","react","redux","tailwindcss","typescript","vite"],"latest_commit_sha":null,"homepage":"https://snippit.onrender.com/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/IndieCoderMM.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-07-14T18:28:52.000Z","updated_at":"2023-10-31T17:55:14.000Z","dependencies_parsed_at":"2023-07-15T19:12:41.800Z","dependency_job_id":"53dd83b3-bb1a-4e08-82a8-37e1b930728f","html_url":"https://github.com/IndieCoderMM/snippit-ui","commit_stats":null,"previous_names":["indiecodermm/snippit-ui"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IndieCoderMM%2Fsnippit-ui","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IndieCoderMM%2Fsnippit-ui/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IndieCoderMM%2Fsnippit-ui/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IndieCoderMM%2Fsnippit-ui/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/IndieCoderMM","download_url":"https://codeload.github.com/IndieCoderMM/snippit-ui/tar.gz/refs/heads/dev","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248670502,"owners_count":21142901,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["code-sharing-platform","collaborate","communityexchange","open-source","react","redux","tailwindcss","typescript","vite"],"created_at":"2025-01-15T23:24:13.196Z","updated_at":"2025-04-13T05:53:52.487Z","avatar_url":"https://github.com/IndieCoderMM.png","language":"TypeScript","readme":"\u003ca name=\"readme-top\"\u003e\u003c/a\u003e\n\n[![Contributors](https://img.shields.io/github/contributors/IndieCoderMM/snippit-ui)](https://github.com/IndieCoderMM/snippit-ui/graphs/contributors)\n[![LastUpdate](https://img.shields.io/github/last-commit/IndieCoderMM/snippit-ui)](https://github.com/IndieCoderMM/snippit-ui/commits/dev)\n[![Stargazers](https://img.shields.io/github/stars/IndieCoderMM/snippit-ui)](https://github.com/IndieCoderMM/snippit-ui/stargazers)\n[![Issues](https://img.shields.io/github/issues/IndieCoderMM/snippit-ui)](https://github.com/IndieCoderMM/snippit-ui/issues)\n[![License](https://img.shields.io/github/license/IndieCoderMM/snippit-ui)](https://github.com/IndieCoderMM/snippit-ui/blob/main/LICENSE)\n[![GitHub pull-requests merged](https://badgen.net/github/merged-prs/IndieCoderMM/snippit-ui)](https://github.com/IndieCoderMM/snippit-ui/pulls?q=is%3Amerged)\n[![Open Source Love](https://badges.frapsoft.com/os/v2/open-source.svg?v=103)](https://github.com/ellerbrock/open-source-badges/)\n\n\u003cdetails\u003e\n\u003csummary\u003eTable of Contents\u003c/summary\u003e\n\n- [💻 About Snippit](#-about-snippit)\n  - [🧰 Tech Stack](#-tech-stack)\n  - [📘 Getting Started](#-getting-started)\n    - [📋 Prerequisites](#-prerequisites)\n    - [📥 Installation](#-installation)\n    - [⚙ Configuration](#-configuration)\n    - [💻 Usage](#-usage)\n  - [📂 Project Structure](#-project-structure)\n  - [🤝 Contributing](#-contributing)\n  - [👨‍🚀 Authors](#-authors)\n  - [💖 Show Your Support](#-show-your-support)\n  - [📜 License](#-license)\n\u003c/details\u003e\n\n# 💻 About Snippit\n\n`Community-driven code-sharing platform`\n\n\u003e This is the front-end codebase for Snippit. The back-end repository can be found at [PrantoshB/Snippit](https://github.com/PrantoshB/Snippit).\n\n\n**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.\n\n\u003cimg src=\"https://via.placeholder.com/468x300?text=App+Screenshot+Here\" width=468 height=300 alt=\"screenshot\" /\u003e\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n## 🧰 Tech Stack\n\n- **React**\n- **Redux Toolkit**\n- **TypeScript**\n- **Tailwind CSS**\n- **Vite**\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\n## 📘 Getting Started\n\nTo run this project locally, follow these steps.\n\n### 📋 Prerequisites\n\nMake sure you have the following installed on your machine:\n- [Node.js v20.2 or higher](https://nodejs.org/en)\n- [NPM v9.6.6 or higher](https://rubyonrails.org/)\n- [Backend Server](https://github.com/PrantoshB/Snippit): Make sure you have the backend repository for this project **set up and running before proceeding with the frontend setup**.\n\n### 📥 Installation\n\n1. Clone this repository to your project folder.\n\n```sh\ncd my-project\ngit clone git@github.com:IndieCoderMM/snippit-ui.git .\n```\n\n2. Install the dependencies:\n\n```sh\nnpm install\n```\n\n### ⚙ Configuration\n\nCreate a `.env.local` file in the root directory and add your API endpoint URL:\n\n```sh\nVITE_API_URL=http://localhost:3000/api/v1\n```\n\n### 💻 Usage\n\nTo run the project, execute the following command:\n\n```sh\nnpm run dev\n```\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n## 📂 Project Structure\n\nThis is an overview of the `./src` directory.\n\n```sh\n.\n├── app/\n│   ├── App.tsx\n│   └── store.ts\n├── assets\n├── common/\n│   ├── components\n│   ├── services\n│   └── constants\n├── features/\n│   ├── snippets/\n│   │   ├── SnippetCard.tsx\n│   │   └── snippetsSlice.ts\n│   └── contributors\n├── pages/\n│   ├── Home.tsx\n│   └── About.tsx\n├── index.css\n└── main.tsx\n```\n\n- `app/`: App-wide setup and layout\n- `common/`: Shared code and resources\n  - `components/`: Reusable components across different pages\n  - `services/`: Interacting with the backend API\n- `features/`: Feature-specific folders\n  - `snippets/`: Components and functions related to snippets\n- `pages/`: Main pages of the app\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n## 🤝 Contributing\n\nWe welcome contributions from the community! \n\nIf you'd like to contribute to the project, please follow the guidelines outlined in [CONTRIBUTING.md](./CONTRIBUTING.md). We appreciate your help!\n\nIf you encounter any issues, have feature requests, or want to report a bug, please open an issue on the [Issues](https://github.com/IndieCoderMM/snippit-ui/issues) page. We'll do our best to address them.\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n## 👨‍🚀 Authors\n\nWe are always looking for ways to improve this project. If you have any suggestions or ideas, we would love to hear from you.\n\n| Name | Connect |\n| --- | :---: |\n| **Prantosh Biswas** | [![Github](https://img.shields.io/badge/GitHub-673AB7?logo=github\u0026logoColor=white)](https://github.com/PrantoshB) [![Linkedin](https://img.shields.io/badge/LinkedIn-0077B5?logo=linkedin\u0026logoColor=white)](https://linkedin.com/in/prantosh) [![Gmail](https://img.shields.io/badge/Gmail-D14836?logo=gmail\u0026logoColor=white)](mailto:pbiswas1007@gmail.com) | \n| **Hein Thant** | [![Github](https://img.shields.io/badge/GitHub-673AB7?logo=github\u0026logoColor=white)](https://github.com/IndieCoderMM) [![Linkedin](https://img.shields.io/badge/LinkedIn-0077B5?logo=linkedin\u0026logoColor=white)](https://linkedin.com/in/hthantoo) [![Gmail](https://img.shields.io/badge/Gmail-D14836?logo=gmail\u0026logoColor=white)](mailto:hthant00chk@gmail.com) |\n\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n## 💖 Show Your Support\n\nIf you find this project useful or interesting, please consider giving it a star ⭐️. \nIt helps us gain visibility and encourages us to continue improving and adding new features.\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n## 📜 License \n\nThis project is licensed under the [MIT License](./LICENSE).\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Findiecodermm%2Fsnippit-ui","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Findiecodermm%2Fsnippit-ui","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Findiecodermm%2Fsnippit-ui/lists"}