{"id":18146453,"url":"https://github.com/innosan/ml-edu-platform","last_synced_at":"2025-04-06T20:45:18.381Z","repository":{"id":259291216,"uuid":"868533339","full_name":"Innosan/ml-edu-platform","owner":"Innosan","description":"A web application that uses AI to evaluate essays, providing feedback on grammar, style, coherence, and overall proficiency. This tool is designed to assist students and writers in improving their essay writing skills","archived":false,"fork":false,"pushed_at":"2024-10-23T18:09:43.000Z","size":207,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-10-24T05:32:24.387Z","etag":null,"topics":["education","nuxt","web"],"latest_commit_sha":null,"homepage":"https://ml-edu-platform.netlify.app","language":"Vue","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Innosan.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-10-06T16:18:06.000Z","updated_at":"2024-10-23T18:10:15.000Z","dependencies_parsed_at":"2024-10-24T05:32:42.395Z","dependency_job_id":"c348fdff-0a47-4310-8bd7-101d5497ab8e","html_url":"https://github.com/Innosan/ml-edu-platform","commit_stats":null,"previous_names":["innosan/ml-edu-platform"],"tags_count":0,"template":false,"template_full_name":"Innosan/nuxt-template-project","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Innosan%2Fml-edu-platform","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Innosan%2Fml-edu-platform/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Innosan%2Fml-edu-platform/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Innosan%2Fml-edu-platform/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Innosan","download_url":"https://codeload.github.com/Innosan/ml-edu-platform/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247550642,"owners_count":20956984,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["education","nuxt","web"],"created_at":"2024-11-01T21:07:47.817Z","updated_at":"2025-04-06T20:45:18.127Z","avatar_url":"https://github.com/Innosan.png","language":"Vue","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Write Grade\n\nA web application that uses AI to evaluate essays, providing feedback on grammar, style, coherence, and overall proficiency. This tool is designed to assist students and writers in improving their essay writing skills\n\n## Folder Structure\n\n- `assets/`: Contains static assets like stylesheets.\n\t- `styles/`: Main styles directory.\n\t\t- `css/`: Contains CSS files.\n\t\t- `scss/`: Contains SCSS files.\n- `components/`: Contains Vue components.\n\t- `layout/section/`: Components for layout sections.\n\t\t- `PageSection.vue`: Component for page sections.\n\t\t- `SectionTitle.vue`: Component for section titles.\n\t- `navigation/`: Components for navigation.\n\t\t- `BurgerNavigation.vue`: Component for burger menu navigation.\n\t\t- `IconedNavigationLink.vue`: Component for navigation links with icons.\n\t\t- `SidebarNavigation.vue`: Component for sidebar navigation.\n\t\t- `TopNavigation.vue`: Component for top navigation.\n\t- `theming/`: Components for theming.\n\t\t- `ColorSwitch.vue`: Component for switching colors.\n\t\t- `ThemeSwitch.vue`: Component for switching themes.\n\t- `utility/`: Utility components.\n\t\t- `Header.vue`: Header component.\n- `pages/`: Contains page components.\n\t- `about.vue`: About page.\n\t- `help.vue`: Help page.\n\t- `index.vue`: Home page.\n- `public/`: Contains public assets.\n\t- `favicon.ico`: Favicon for the application.\n\t- `fonts/`: Contains font files.\n\t\t- `Manrope-VariableFont_wght.ttf`: Manrope font.\n\t- `images/`: Contains image files.\n\t\t- `delete.ts`: Example image file.\n- `server/`: Contains server-side code.\n\t- `tsconfig.json`: TypeScript configuration for the server.\n- `stores/`: Contains Pinia stores.\n\t- `settings.ts`: Store for managing application settings.\n- `types/`: Contains TypeScript type definitions.\n\t- `ui/`: UI-related types.\n\t\t- `SectionSizes.ts`: Type definitions for section sizes.\n\t- `utility/`: Utility types.\n\t\t- `NavigationLink.ts`: Type definitions for navigation links.\n- `utils/`: Contains utility functions.\n\t- `navigation.ts`: Utility functions for navigation.\n\n## Explanation\n\nThe project is structured to separate concerns and improve maintainability:\n\n- **Assets**: Static files like stylesheets are organized under `assets` to keep them separate from the application logic.\n- **Components**: Vue components are organized by their functionality (layout, navigation, theming, utility) to make it easier to find and manage them.\n- **Pages**: Each page of the application has its own file under `pages`, following the Nuxt.js convention.\n- **Public**: Public assets like fonts and images are placed under `public` to be served directly.\n- **Server**: Server-side code is kept under `server` to separate it from client-side code.\n- **Stores**: State management is handled using Pinia stores, which are placed under `stores`.\n- **Types**: TypeScript type definitions are organized under `types` to ensure type safety across the application.\n- **Utils**: Utility functions are placed under `utils` for reusability and better organization.\n\n## Stores\n\n### `stores/settings.ts`\n\nThis file contains the settings store which manages the application's settings, such as the primary color. It uses Pinia for state management.\n\n## Setup\n\nMake sure to install the dependencies:\n\n```bash\n# npm\nnpm install\n```\n\n```bash\n# pnpm\npnpm install\n```\n\n```bash\n# yarn\nyarn install\n```\n\n```bash\n# bun\nbun install\n```\n\n## Deployment\n\nDon't forget to create .env file with the following content:\n```dotenv\nNUXT_PUBLIC_API_URL=YOUR_API_URL\n```\n\nThen run the following command to start the application:\n\n```bash\n# bun\nbun run dev\n```\n\n```bash\n# npm\nnpm run dev\n```\n\n```bash\n# pnpm\npnpm run dev\n```\n\n```bash\n# yarn\nyarn dev\n```\n\nCheck out the [Deployment guide](https://nuxt.com/docs/getting-started/deployment) for more information.  \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finnosan%2Fml-edu-platform","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Finnosan%2Fml-edu-platform","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finnosan%2Fml-edu-platform/lists"}