mirror of
https://github.com/Snigdha-OS/snigdhaos-web-dev.git
synced 2026-02-07 17:53:51 +01:00
161 lines
5.5 KiB
Markdown
161 lines
5.5 KiB
Markdown
|
||
# Snigdha OS Web Dev 🌐💻
|
||
|
||
Welcome to the **Snigdha OS Web Dev** repository! 🎉 This repository contains the source code, components, and resources used for building and maintaining the official website for **Snigdha OS**. 🚀
|
||
<div align="center">
|
||
[](https://app.netlify.com/sites/snigdhaos/deploys)
|
||
</div>
|
||
|
||
## Table of Contents 📑
|
||
|
||
- [Overview](#overview) 🌟
|
||
- [Features](#features) ✨
|
||
- [Technologies Used](#technologies-used) ⚙️
|
||
- [Repository Structure](#repository-structure) 📂
|
||
- [Developers](#developers) 👨💻👩💻
|
||
- [Development Guide](#development-guide) 🛠️
|
||
- [Contributing](#contributing) 🤝
|
||
- [License](#license) 📜
|
||
|
||
|
||
|
||
## Overview 🌟
|
||
|
||
The **Snigdha OS Web Dev** repository powers the official website for the next **Snigdha OS**. It includes various web development components, styles, and scripts necessary for the website's functionality. The website is designed to be clean, lightweight, and user-friendly, aligning with the minimalist philosophy of Snigdha OS. 🖥️
|
||
|
||
|
||
|
||
## Features ✨
|
||
|
||
- 📱 **Responsive Design**: Works seamlessly across devices and screen sizes.
|
||
- 🔑 **User Registration & Authentication**: Integrated with the Snigdha OS user system.
|
||
- 🌍 **Region-based Downloads**: Select regional mirrors for faster downloads.
|
||
- 🎨 **Customizable UI**: Built for flexibility and easy theming.
|
||
- 🌐 **SEO Optimization**: Ensures better discoverability on search engines.
|
||
|
||
|
||
|
||
## Technologies Used ⚙️
|
||
|
||
This project leverages modern technologies to deliver an efficient and scalable experience:
|
||
|
||
- ⚛️ **React.js**: For building dynamic user interfaces.
|
||
- 🟢 **Node.js**: A runtime environment for server-side JavaScript.
|
||
- 🚀 **Express.js**: Minimal web framework for backend API routes.
|
||
- 🗂️ **Redux**: State management for predictable application behavior.
|
||
- 🎨 **CSS3 & Sass**: Styling with modern techniques like Flexbox and Grid.
|
||
- 📦 **Webpack**: Bundling JavaScript and assets for optimized performance.
|
||
- ✅ **Jest**: Testing framework for unit and integration tests.
|
||
- 🛠️ **ESLint**: For consistent and error-free JavaScript code.
|
||
|
||
|
||
|
||
## Repository Structure 📂
|
||
|
||
The repository is organized for clarity and modularity:
|
||
|
||
```plaintext
|
||
snigdhaos-web-dev/
|
||
├── src/ # Main source code
|
||
│ ├── components/ # Reusable components (Header, Footer, Forms)
|
||
│ ├── pages/ # Website pages (Home, About, Download)
|
||
│ ├── styles/ # Global and component-specific styles
|
||
│ ├── utils/ # Utility functions and helpers
|
||
│ └── App.js # Root React component
|
||
├── public/ # Static assets (images, icons, fonts)
|
||
├── tests/ # Unit and integration tests
|
||
├── package.json # Project dependencies and scripts
|
||
├── pnpm-lock.yaml # Lockfile for pnpm dependencies
|
||
├── README.md # This README file
|
||
├── .eslintrc.js # ESLint configuration
|
||
├── .gitignore # Files to ignore in Git
|
||
└── LICENSE # License file
|
||
```
|
||
|
||
### Key Folders 📁
|
||
|
||
- **`src/components/`**: Modular, reusable UI components like navigation bars and forms.
|
||
- **`src/pages/`**: Individual pages of the website, such as Home, About, and Download.
|
||
- **`src/styles/`**: Stylesheets for consistent design across the website.
|
||
- **`public/`**: Static files served directly without processing.
|
||
|
||
|
||
|
||
## Developers 👨💻👩💻
|
||
|
||
Meet the amazing contributors behind Snigdha OS Web Dev:
|
||
|
||
- **[Eshanized](https://github.com/eshanized/)** - Lead Developer, Web Architect 🌟
|
||
|
||
We’re always looking for passionate developers to join the team! 💖
|
||
|
||
|
||
|
||
## Development Guide 🛠️
|
||
|
||
### Prerequisites ⚡
|
||
|
||
To start working on the project, you need:
|
||
- **Node.js** and **pnpm** installed on your machine.
|
||
- A modern browser for testing (e.g., Chrome, Firefox).
|
||
- A code editor like VSCode for efficient development.
|
||
- Familiarity with React.js, JavaScript, and Git.
|
||
|
||
### Setting Up the Development Environment 🚀
|
||
|
||
1. Clone the repository:
|
||
```bash
|
||
git clone https://github.com/Snigdha-OS/snigdhaos-web-dev.git
|
||
cd snigdhaos-web-dev
|
||
```
|
||
|
||
2. Install dependencies:
|
||
```bash
|
||
pnpm install
|
||
```
|
||
|
||
3. Run the development server:
|
||
```bash
|
||
pnpm start
|
||
```
|
||
|
||
The server will start at `http://localhost:5173`. Changes to the code will auto-refresh in your browser.
|
||
|
||
|
||
|
||
## Contributing 🤝
|
||
|
||
We welcome contributions! Here’s how you can contribute:
|
||
|
||
1. **Fork the repository**:
|
||
Click the “Fork” button at the top of the page to create your copy.
|
||
|
||
2. **Create a branch** for your feature or bug fix:
|
||
```bash
|
||
git checkout -b feature-name
|
||
```
|
||
|
||
3. **Make your changes**:
|
||
Write clean and well-documented code.
|
||
|
||
4. **Commit your changes**:
|
||
```bash
|
||
git commit -m "Add: Feature description"
|
||
```
|
||
|
||
5. **Push to your fork** and submit a pull request:
|
||
```bash
|
||
git push origin feature-name
|
||
```
|
||
|
||
|
||
|
||
## License 📜
|
||
|
||
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
|
||
|
||
|
||
|
||
<div align="center">
|
||
💖 Thanks for being part of the Snigdha OS Web Dev journey! 🌟
|
||
</div> |