Repository files navigation

WordSage 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.

• ✨Personalized Learning: WordSage customizes the learning experience based on each user's skill level and progress, ensuring efficient learning.
• 📘Vast Vocabulary: Access a comprehensive database of words, including their meanings, synonyms, antonyms, and example sentences with voice pronunciations.
• 🧠Interactive Quizzes: Engage in quizzes that are interactive, reinforcing your learning and allowing you to track your progress over time.
• 👤User Profiles: Create user profiles to monitor your learning journey.
• 🖥️Admin Panel: The intuitive admin panel, built with React, enables easy management of app content and user data.
• 📱Cross-Platform: The app is built with React Native, allowing it to run on both Android and iOS devices.

• ⚛️Frontend: React Native, Redux Toolkit
• 🧱Backend: NestJS
• 💾Database: MongoDB
• 🎨Admin Panel: React, Vite, and Tailwind CSS

• 📦 Node.js (Developed with v16)
• 🗄️ MongoDB or MongoDB Atlas
• 📱 Expo Go app (for Android)

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.

1. Clone the repository:

   git clone https://github.com/nz-m/WordSage.git

2. Install dependencies:

Navigate to the project directory and run the following command in each of the directories:frontend,backend, andadmin-panel

npm install

3. Create.env files:Create .env files in thebackend andadmin-panel directories following the format in the.env.example file.

4. Setup backend URL in frontend:In thefrontend directory, locate thebaseUrl.js file in theconstants folder and change the value of theAPI_BASE_URL variable to the URL of the backend server.

5. Start the backend server:

npm start

Accesshttp://127.0.0.1:4000/docs to view the API documentation. 6.Start the admin panel

npm start

7. Access the admin panel athttp://127.0.0.1:5173/ and add learning contents:

   Note: You will find instructions on how to add content in the admin panel itself. The learningcontents are stored in thebackend directory in theresources folder with appropriate file names.

8. Start the app (frontend):

npm start

Scan the QR code using the Expo Go app to run the app on your mobile device.

Contributions are welcome. SeeCONTRIBUTING.md for more details.

If you have any feedback, please reach out to me atneaz6160@gmail.com

This project is licensed under theMIT License.