{"id":19681125,"url":"https://github.com/nz-m/wordsage","last_synced_at":"2025-04-29T04:31:50.838Z","repository":{"id":184546042,"uuid":"672078721","full_name":"nz-m/WordSage","owner":"nz-m","description":"Personalized English Vocabulary Learning App Built with React Native \u0026 NestJS","archived":false,"fork":false,"pushed_at":"2023-10-01T20:27:30.000Z","size":2894,"stargazers_count":38,"open_issues_count":1,"forks_count":8,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-05T13:11:13.277Z","etag":null,"topics":["android-application","ios-app","jwt-authentication","mongodb","mongodb-atlas","nestjs","nestjs-backend","nestjs-mongoose","quizapp","react","react-native","redux-toolkit"],"latest_commit_sha":null,"homepage":"https://youtu.be/mM8SDkkgZN0","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nz-m.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2023-07-28T21:41:49.000Z","updated_at":"2025-02-18T14:09:42.000Z","dependencies_parsed_at":"2023-09-26T23:16:54.489Z","dependency_job_id":null,"html_url":"https://github.com/nz-m/WordSage","commit_stats":null,"previous_names":["nz-m/wordsage"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nz-m%2FWordSage","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nz-m%2FWordSage/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nz-m%2FWordSage/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nz-m%2FWordSage/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nz-m","download_url":"https://codeload.github.com/nz-m/WordSage/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251432920,"owners_count":21588677,"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":["android-application","ios-app","jwt-authentication","mongodb","mongodb-atlas","nestjs","nestjs-backend","nestjs-mongoose","quizapp","react","react-native","redux-toolkit"],"created_at":"2024-11-11T18:07:00.257Z","updated_at":"2025-04-29T04:31:50.369Z","avatar_url":"https://github.com/nz-m.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv style=\"text-align: center;\"\u003e\n  \u003ch1\u003eWordSage 📚📱\u003c/h1\u003e\n\u003c/div\u003e\n\nWordSage is a personalized English vocabulary learning app built with React Native and NestJS, designed to help users enhance their vocabulary in an engaging and effective way. The application covers over 1500 words, including their meanings, synonyms, antonyms, and example sentences. It also offers interactive quizzes to reinforce learning and track progress over time.\n\n## 🚀 Features\n\n- ✨ **Personalized Learning:** WordSage customizes the learning experience based on each user's skill level and progress, ensuring efficient learning.\n- 📘 **Vast Vocabulary:** Access a comprehensive database of words, including their meanings, synonyms, antonyms, and example sentences with voice pronunciations.\n- 🧠 **Interactive Quizzes:** Engage in quizzes that are interactive, reinforcing your learning and allowing you to track your progress over time.\n- 👤 **User Profiles:** Create user profiles to monitor your learning journey.\n- 🖥️ **Admin Panel:** The intuitive admin panel, built with React, enables easy management of app content and user data.\n- 📱 **Cross-Platform:** The app is built with React Native, allowing it to run on both Android and iOS devices.\n\n## 🛠️ Tech Stack\n\n- ⚛️ **Frontend:** React Native, Redux Toolkit\n- 🧱 **Backend:** NestJS\n- 💾 **Database:** MongoDB\n- 🎨 **Admin Panel:** React, Vite, and Tailwind CSS\n\n## ⚙️ Installation\n\n### 📋 Prerequisites\n\n- 📦 Node.js (Developed with v16)\n- 🗄️ MongoDB or MongoDB Atlas\n- 📱 Expo Go app (for Android)\n\n\u003e Note: Newer versions of Node.js may not be compatible with the dependencies used in the frontend. If you encounter any issues, consider using NVM to manage multiple versions of Node.js on your machine.\n\n### 📝 Steps\n\n1. **Clone the repository:**\n\n   ```bash\n   git clone https://github.com/nz-m/WordSage.git\n\n   ```\n\n2. **Install dependencies:**\n\nNavigate to the project directory and run the following command in each of the directories: `frontend`, `backend`, and `admin-panel`\n\n```bash\nnpm install\n```\n\n3. **Create `.env` files:**\n   Create .env files in the `backend` and `admin-panel` directories following the format in the `.env.example` file.\n4. **Setup backend URL in frontend:**\n   In the `frontend` directory, locate the `baseUrl.js` file in the `constants` folder and change the value of the `API_BASE_URL` variable to the URL of the backend server.\n\n5. **Start the backend server:**\n\n```bash\nnpm start\n```\n\n\u003e Access `http://127.0.0.1:4000/docs` to view the API documentation. 6. **Start the admin panel**\n\n```bash\nnpm start\n```\n\n7. **Access the admin panel at `http://127.0.0.1:5173/` and add learning contents:**\n\n   \u003e Note: You will find instructions on how to add content in the admin panel itself. The learning\n   \u003e contents are stored in the `backend` directory in the `resources` folder with appropriate file names.\n\n8. **Start the app (frontend):**\n\n```bash\nnpm start\n```\n\nScan the QR code using the Expo Go app to run the app on your mobile device.\n\n## 📷 Screenshots\n\n\u003cdiv style=\"display: flex; flex-direction: row; gap: 10px; justify-content: center;\"\u003e\n  \u003cimg src=\"screenshots/login.jpg\" alt=\"Login\" style=\"width: 40%; margin: 0;\"\u003e\n  \u003cimg src=\"screenshots/home.jpg\" alt=\"Home\" style=\"width: 40%; margin: 0;\"\u003e\n\u003c/div\u003e\n\n\u003cdiv style=\"display: flex; flex-direction: row; gap: 10px; justify-content: center;\"\u003e\n  \u003cimg src=\"screenshots/profile.jpg\" alt=\"Profile\" style=\"width: 40%; margin: 0;\"\u003e\n  \u003cimg src=\"screenshots/vocabulary.jpg\" alt=\"Vocabulary\" style=\"width: 40%; margin: 0;\"\u003e\n\u003c/div\u003e\n\n\u003cdiv style=\"display: flex; flex-direction: row; gap: 10px; justify-content: center;\"\u003e\n  \u003cimg src=\"screenshots/quiz.jpg\" alt=\"Quiz\" style=\"width: 40%; margin: 0;\"\u003e\n  \u003cimg src=\"screenshots/result.jpg\" alt=\"Result\" style=\"width: 40%; margin: 0;\"\u003e\n\u003c/div\u003e\n\n\u003cdiv style=\"display: flex; flex-direction: row; gap: 10px; justify-content: center;\"\u003e\n  \u003cimg src=\"screenshots/proficiency-assessment.jpg\" alt=\"Proficiency Assessment\" style=\"width: 40%; margin: 0;\"\u003e\n  \u003cimg src=\"screenshots/assessment-prompt.jpg\" alt=\"Assessment Prompt\" style=\"width: 40%; margin: 0;\"\u003e\n\u003c/div\u003e\n\n\u003cdiv style=\"display: flex; flex-direction: row; gap: 10px; justify-content: center;\"\u003e\n  \u003cimg src=\"screenshots/lessons.jpg\" alt=\"Lessons\" style=\"width: 40%; margin: 0;\"\u003e\n\u003c/div\u003e\n\n  \u003cimg src=\"screenshots/Admin-panel.png\" alt=\"Admin Panel\"\u003e\n  \u003cimg src=\"screenshots/Manage-questions.png\" alt=\"Manage Questions\"\u003e\n\n## 🤝 Contributing\n\nContributions are welcome. See [CONTRIBUTING.md](https://github.com/nz-m/WordSage/blob/main/CONTRIBUTING.md) for more details.\n\n\n## 📬 Feedback\n\nIf you have any feedback, please reach out to me at [neaz6160@gmail.com](mailto:neaz6160@gmail.com)\n\n## 📄 License\n\nThis project is licensed under the [MIT License.](https://github.com/nz-m/WordSage/blob/main/LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnz-m%2Fwordsage","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnz-m%2Fwordsage","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnz-m%2Fwordsage/lists"}