Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/indiecodermm/snippit-ui
Snippit: Code-sharing platform to learn, explore and innovate together | Front End Repo | React, Redux, RoR, Postgres
https://github.com/indiecodermm/snippit-ui
code-sharing-platform collaborate communityexchange open-source react redux tailwindcss typescript vite
Last synced: about 6 hours ago
JSON representation
Snippit: Code-sharing platform to learn, explore and innovate together | Front End Repo | React, Redux, RoR, Postgres
- Host: GitHub
- URL: https://github.com/indiecodermm/snippit-ui
- Owner: IndieCoderMM
- License: mit
- Created: 2023-07-14T18:28:52.000Z (over 1 year ago)
- Default Branch: dev
- Last Pushed: 2023-09-25T10:47:43.000Z (over 1 year ago)
- Last Synced: 2023-09-25T18:17:21.020Z (over 1 year ago)
- Topics: code-sharing-platform, collaborate, communityexchange, open-source, react, redux, tailwindcss, typescript, vite
- Language: TypeScript
- Homepage: https://snippit.onrender.com/
- Size: 339 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 14
-
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/IndieCoderMM/snippit-ui/graphs/contributors)
[](https://github.com/IndieCoderMM/snippit-ui/commits/dev)
[](https://github.com/IndieCoderMM/snippit-ui/stargazers)
[](https://github.com/IndieCoderMM/snippit-ui/issues)
[](https://github.com/IndieCoderMM/snippit-ui/blob/main/LICENSE)
[](https://github.com/IndieCoderMM/snippit-ui/pulls?q=is%3Amerged)
[](https://github.com/ellerbrock/open-source-badges/)
Table of Contents
- [💻 About Snippit](#-about-snippit)
- [🧰 Tech Stack](#-tech-stack)
- [📘 Getting Started](#-getting-started)
- [📋 Prerequisites](#-prerequisites)
- [📥 Installation](#-installation)
- [⚙ Configuration](#-configuration)
- [💻 Usage](#-usage)
- [📂 Project Structure](#-project-structure)
- [🤝 Contributing](#-contributing)
- [👨🚀 Authors](#-authors)
- [💖 Show Your Support](#-show-your-support)
- [📜 License](#-license)
# 💻 About Snippit
`Community-driven code-sharing platform`
> This is the front-end codebase for Snippit. The back-end repository can be found at [PrantoshB/Snippit](https://github.com/PrantoshB/Snippit).
**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.
## 🧰 Tech Stack
- **React**
- **Redux Toolkit**
- **TypeScript**
- **Tailwind CSS**
- **Vite**
## 📘 Getting Started
To run this project locally, follow these steps.
### 📋 Prerequisites
Make sure you have the following installed on your machine:
- [Node.js v20.2 or higher](https://nodejs.org/en)
- [NPM v9.6.6 or higher](https://rubyonrails.org/)
- [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**.
### 📥 Installation
1. Clone this repository to your project folder.
```sh
cd my-project
git clone [email protected]:IndieCoderMM/snippit-ui.git .
```
2. Install the dependencies:
```sh
npm install
```
### ⚙ Configuration
Create a `.env.local` file in the root directory and add your API endpoint URL:
```sh
VITE_API_URL=http://localhost:3000/api/v1
```
### 💻 Usage
To run the project, execute the following command:
```sh
npm run dev
```
## 📂 Project Structure
This is an overview of the `./src` directory.
```sh
.
├── app/
│ ├── App.tsx
│ └── store.ts
├── assets
├── common/
│ ├── components
│ ├── services
│ └── constants
├── features/
│ ├── snippets/
│ │ ├── SnippetCard.tsx
│ │ └── snippetsSlice.ts
│ └── contributors
├── pages/
│ ├── Home.tsx
│ └── About.tsx
├── index.css
└── main.tsx
```
- `app/`: App-wide setup and layout
- `common/`: Shared code and resources
- `components/`: Reusable components across different pages
- `services/`: Interacting with the backend API
- `features/`: Feature-specific folders
- `snippets/`: Components and functions related to snippets
- `pages/`: Main pages of the app
## 🤝 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/IndieCoderMM/snippit-ui/issues) page. We'll do our best to address them.
## 👨🚀 Authors
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 | Connect |
| --- | :---: |
| **Prantosh Biswas** | [](https://github.com/PrantoshB) [](https://linkedin.com/in/prantosh) [](mailto:[email protected]) |
| **Hein Thant** | [](https://github.com/IndieCoderMM) [](https://linkedin.com/in/hthantoo) [](mailto:[email protected]) |
## 💖 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).