Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .eslintrc.js
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,4 @@ module.exports = {
version: 'detect',
},
},
};
};
3 changes: 0 additions & 3 deletions .github/ISSUE_TEMPLATE/custom.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,4 @@ about: Describe this issue template's purpose here.
title: ''
labels: ''
assignees: ''

---


1 change: 0 additions & 1 deletion .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ about: Suggest an idea for this project
title: ''
labels: ''
assignees: ''

---

**Is your feature request related to a problem? Please describe.**
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -34,4 +34,4 @@ jobs:
git remote set-url origin https://git:${GITHUB_TOKEN}@github.com/${GITHUB_REPOSITORY}.git
npx gh-pages -d dist --cname www.sugarlabs.org -u "github-actions-bot <support+actions@github.com>"
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
2 changes: 1 addition & 1 deletion .github/workflows/integration.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,4 @@ jobs:
run: npm install

- name: Build the project
run: npm run build
run: npm run build
2 changes: 1 addition & 1 deletion .github/workflows/linting.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,4 +33,4 @@ jobs:
run: npm run lint:md

- name: Check code formatting with Prettier
run: npm run format:check
run: npm run format:check
2 changes: 1 addition & 1 deletion .markdownlint.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@
"MD013": false,
"MD033": false,
"MD041": false
}
}
2 changes: 1 addition & 1 deletion .prettierrc
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@
"trailingComma": "all",
"printWidth": 80,
"tabWidth": 2
}
}
2 changes: 2 additions & 0 deletions docs/Adding_favicon.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,12 @@
## Steps to Add a New Favicon

1. **Prepare the Favicon File:**

- Create an SVG (preferred) or PNG file for the favicon.
- Ensure the favicon design aligns with the existing ones.

2. **Place the Favicon in the Correct Directory:**

- Move the favicon file to the `public/favicons/` folder.

3. **Update the Favicon List:**
Expand Down
37 changes: 19 additions & 18 deletions docs/GSoC-Blogpost-Guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,15 @@ Use the exact template below for every GSoC ’25 week update or you will also f

```markdown
---
title: "GSoC ’25 Week XX Update by Safwan Sayeed"
excerpt: "This is a Template to write Blog Posts for weekly updates"
category: "TEMPLATE"
date: "2025-05-10"
slug: "gsoc-25-sa-fw-an-weekX"
author: "Safwan Sayeed"
title: 'GSoC ’25 Week XX Update by Safwan Sayeed'
excerpt: 'This is a Template to write Blog Posts for weekly updates'
category: 'TEMPLATE'
date: '2025-05-10'
slug: 'gsoc-25-sa-fw-an-weekX'
author: 'Safwan Sayeed'
description: "Maintainer and GSoC'25 Contributor at SugarLabs"
tags: "gsoc25,sugarlabs,weekXX,sa-fw-an"
image: "assets/Images/GSOC.png"
tags: 'gsoc25,sugarlabs,weekXX,sa-fw-an'
image: 'assets/Images/GSOC.png'
---

<!-- markdownlint-disable -->
Expand All @@ -28,7 +28,7 @@ image: "assets/Images/GSOC.png"
**Project:** [Project Name](https://github.com/sugarlabs/project_repo)
**Mentors:** [Mentor1](https://github.com/Username), [Mentor2](https://github.com/Username)
**Assisting Mentors:** [Mentor3](https://github.com/Username), [Mentor4](https://github.com/Username)
**Reporting Period:** yyyy-mm-dd - yyyy-mm-dd
**Reporting Period:** yyyy-mm-dd - yyyy-mm-dd

---

Expand All @@ -42,17 +42,19 @@ image: "assets/Images/GSOC.png"

## This Week’s Achievements

1. **[Task or Feature]**
- What you did and why it matters.
1. **[Task or Feature]**

- What you did and why it matters.
- Links (if any): PR [#123](https://github.com/owner/repo/pull/123), Issue [#456](https://github.com/owner/repo/issues/456).

2. **[Task or Feature]**
2. **[Task or Feature]**

- Brief summary or a video.
[youtube: MM-H69cHYMk]
[youtube: MM-H69cHYMk]

3. **[Task or Feature]**
3. **[Task or Feature]**
- Add screenshots or diagrams here if useful:
![screenshot-description](https://images.unsplash.com/photo-1506744038136-46273834b3fb?w=2070)
![screenshot-description](https://images.unsplash.com/photo-1506744038136-46273834b3fb?w=2070)

---

Expand Down Expand Up @@ -105,7 +107,6 @@ Thank you to my mentors, the Sugar Labs community, and fellow GSoC contributors
- Twitter: [@safwan_say](https://twitter.com/safwan_say)

---

```

## 2. Updating Your Post
Expand All @@ -122,7 +123,7 @@ Thank you to my mentors, the Sugar Labs community, and fellow GSoC contributors

- Branch off `main` with `gsoc-weekXX-username`.
- Add your file under `constants/MarkdownFiles/posts/`.
- Commit and open a PR titled:
- Commit and open a PR titled:
```
GSoC ’25 Week XX Update by Name
```
Expand All @@ -131,4 +132,4 @@ Thank you to my mentors, the Sugar Labs community, and fellow GSoC contributors

---

By strictly following this template and these steps, we ensure every GSoC ’25 post is uniform and high quality. Happy writing!
By strictly following this template and these steps, we ensure every GSoC ’25 post is uniform and high quality. Happy writing!
60 changes: 30 additions & 30 deletions docs/dev_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,19 +6,19 @@

2. Clone your forked copy of the project;

```bash
git clone https://github.com/<your_user_name>/www-v2.git
```
```bash
git clone https://github.com/<your_user_name>/www-v2.git
```

3. Change to the project directory;

```bash
cd www-v2
```
```bash
cd www-v2
```

## Setup Development Environment

This is a _**TypeScript**_ project that uses _**React**_. You'll just need _[**Node.js**](https://nodejs.org/en) and _**npm**_ installed on your development machine.
This is a _**TypeScript**_ project that uses _**React**_. You'll just need [**Node.js**](https://nodejs.org/en) and **npm** installed on your development machine.
Although, this is sufficient to run, build, and test the project as a whole, you might need some
extra tools for other development tasks.

Expand Down Expand Up @@ -55,41 +55,41 @@ After you are set-up, the steps you take depend on what you want to do:

- **Run a development server**

1. To install all the dependencies (in `package.json`), run
1. To install all the dependencies (in `package.json`), run

```bash
npm install
```
```bash
npm install
```

2. Run _React scripts_.
2. Run _React scripts_.

- For unoptimized development serving, run
- For unoptimized development serving, run

```bash
npm run dev
```
```bash
npm run dev
```

Visit `localhost:5173` in a browser to view the web page served.
Visit `localhost:5173` in a browser to view the web page served.

- For generating a generic production build, run
- For generating a generic production build, run

```bash
npm run build
```
```bash
npm run build
```

- For generating a production build under the subdirectory `/www-v2`, run
- For generating a production build under the subdirectory `/www-v2`, run

```bash
npm run build
```
```bash
npm run build
```

- For serving the last production build (`dist` folder), run
- For serving the last production build (`dist` folder), run

```bash
npm run preview
```
```bash
npm run preview
```

Visit `localhost:4173` in a browser to view the web page served.
Visit `localhost:4173` in a browser to view the web page served.

## Editor

Expand Down
12 changes: 6 additions & 6 deletions eslint.config.js
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
import js from '@eslint/js'
import globals from 'globals'
import reactHooks from 'eslint-plugin-react-hooks'
import reactRefresh from 'eslint-plugin-react-refresh'
import tseslint from 'typescript-eslint'
import js from '@eslint/js';
import globals from 'globals';
import reactHooks from 'eslint-plugin-react-hooks';
import reactRefresh from 'eslint-plugin-react-refresh';
import tseslint from 'typescript-eslint';

export default tseslint.config(
{ ignores: ['dist'] },
Expand All @@ -25,4 +25,4 @@ export default tseslint.config(
],
},
},
)
);
17 changes: 13 additions & 4 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,18 @@
<html lang="en">
<head>
<meta charset="UTF-8" />
<link id="dynamic" rel="icon" type="image/svg+xml" href="favicons/favicon1.svg" />
<link href="./src/styles/globals.css" rel="stylesheet">
<link
id="dynamic"
rel="icon"
type="image/svg+xml"
href="favicons/favicon1.svg"
/>
<link href="./src/styles/globals.css" rel="stylesheet" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<base href="/" />
<title>SugarLabs</title>
<script>
(function() {
(function () {
const redirectPath = sessionStorage.getItem('redirectPath');
if (redirectPath) {
sessionStorage.removeItem('redirectPath');
Expand All @@ -20,6 +25,10 @@
<body>
<div id="root"></div>
<script type="module" src="/src/main.tsx"></script>
<script type="module" src="/Randomfavicon.js" crossorigin="anonymous"></script>
<script
type="module"
src="/Randomfavicon.js"
crossorigin="anonymous"
></script>
</body>
</html>
Loading