Skip to content

fix: Remove references to feanil in the package. #14

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
feanil merged 1 commit into from
Dec 23, 2025
+978 −614
Merged

fix: Remove references to feanil in the package. #14

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
30 changes: 15 additions & 15 deletions frontend/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,12 +97,12 @@ useEffect(() => {
const fetchArchivedCourses = async () => {
const client = getAuthenticatedHttpClient();
const lmsBaseUrl = getConfig().LMS_BASE_URL;

const response = await client.get(
`${lmsBaseUrl}/sample-plugin/api/v1/course-archive-status/`,
{ params: { is_archived: true } }
);

const archivedCourseIds = new Set(
response.data.results.map((item) => item.course_id)
);
Expand Down Expand Up @@ -153,15 +153,15 @@ const [loadingStates, setLoadingStates] = useState(new Map());

const handleArchiveToggle = async (courseId, isCurrentlyArchived) => {
setLoadingStates((prev) => new Map(prev).set(courseId, true));

try {
// API calls to backend
if (isCurrentlyArchived) {
// Unarchive logic
} else {
// Archive logic
}

// Update local state
setArchivedCourses((prev) => {
const newSet = new Set(prev);
Expand Down Expand Up @@ -195,7 +195,7 @@ const handleArchiveToggle = async (courseId, isCurrentlyArchived) => {

```javascript
import { DIRECT_PLUGIN, PLUGIN_OPERATIONS } from '@openedx/frontend-plugin-framework';
import { CourseList } from '@feanil/sample-plugin';
import { CourseList } from '@openedx/sample-plugin';

const config = {
pluginSlots: {
Expand Down Expand Up @@ -232,7 +232,7 @@ const config = {
Each slot provides specific props. For CourseListSlot:

```jsx
const CourseList = ({
const CourseList = ({
courseListData, // Course data from platform
// Other props depend on the slot
}) => {
Expand Down Expand Up @@ -277,7 +277,7 @@ try {
data: error.response?.data,
message: error.message,
});

// User feedback
// Consider using toast notifications or error states
}
Expand Down Expand Up @@ -323,7 +323,7 @@ Create `env.config.jsx` in your MFE root (not committed to repo):

```javascript
import { DIRECT_PLUGIN, PLUGIN_OPERATIONS } from '@openedx/frontend-plugin-framework';
import { CourseList } from '@feanil/sample-plugin';
import { CourseList } from '@openedx/sample-plugin';

const config = {
pluginSlots: {
Expand Down Expand Up @@ -355,7 +355,7 @@ Create `module.config.js` for local development:
module.exports = {
localModules: [
{
moduleName: '@feanil/sample-plugin',
moduleName: '@openedx/sample-plugin',
dir: '/path/to/sample-plugin/frontend'
},
],
Expand Down Expand Up @@ -398,9 +398,9 @@ describe('CourseList Plugin', () => {
const mockCourseData = {
visibleList: [/* mock course data */]
};

render(<CourseList courseListData={mockCourseData} />);

expect(screen.getByText('Archive')).toBeInTheDocument();
});
});
Expand Down Expand Up @@ -448,7 +448,7 @@ PLUGIN_SLOTS.add_items([

**API Performance**:
- Implement proper caching strategies
- Use pagination for large datasets
- Use pagination for large datasets
- Optimize backend API response times

**User Experience**:
Expand Down Expand Up @@ -530,7 +530,7 @@ const CourseList = ({ courseListData }) => (
{courses.map(course => (
<Card key={course.id}>
{/* Course info */}
<ArchiveButton
<ArchiveButton
courseId={course.id}
isArchived={isArchived(course.id)}
onToggle={handleArchiveToggle}
Expand All @@ -547,7 +547,7 @@ const CourseList = ({ courseListData }) => (

**Plugin Not Loading**:
- Check `env.config.jsx` slot name matches target slot
- Verify plugin is installed (`npm list @feanil/sample-plugin`)
- Verify plugin is installed (`npm list @openedx/sample-plugin`)
- Ensure MFE supports the plugin framework version
- Check browser console for JavaScript errors

Expand Down Expand Up @@ -600,4 +600,4 @@ console.log("DEBUG: Archive states:", Array.from(archivedCourses));
3. **Community**: [Open edX Slack #frontend-platform channel](https://openedx.org/slack)
4. **Issues**: Report bugs in relevant MFE repositories or this sample repository

This frontend plugin demonstrates the power and flexibility of the Open edX Frontend Plugin Framework. By following these patterns, you can create rich customizations that integrate seamlessly with the Open edX ecosystem.
This frontend plugin demonstrates the power and flexibility of the Open edX Frontend Plugin Framework. By following these patterns, you can create rich customizations that integrate seamlessly with the Open edX ecosystem.
Loading