Table of Contents

• 💻 About Snippit
  • 🧰 Tech Stack
  • 📘 Getting Started
    • 📋 Prerequisites
    • 📥 Installation
    • ⚙ Configuration
    • 💻 Usage
  • 📂 Project Structure
  • 🤝 Contributing
  • 👨‍🚀 Authors
  • 💖 Show Your Support
  • 📜 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.

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)

🧰 Tech Stack

• React
• Redux Toolkit
• TypeScript
• Tailwind CSS
• Vite

(back to top)

📘 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
• NPM v9.6.6 or higher
• Backend Server: 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.

cd my-project
git clone git@github.com:IndieCoderMM/snippit-ui.git .

2. Install the dependencies:

npm install

⚙ Configuration

Create a .env.local file in the root directory and add your API endpoint URL:

VITE_API_URL=http://localhost:3000/api/v1

💻 Usage

To run the project, execute the following command:

npm run dev

(back to top)

📂 Project Structure

This is an overview of the ./src directory.

.
├── 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

(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)

👨‍🚀 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
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)