Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nz-m/wordsage
Personalized English Vocabulary Learning App Built with React Native & NestJS
https://github.com/nz-m/wordsage
android-application ios-app jwt-authentication mongodb mongodb-atlas nestjs nestjs-backend nestjs-mongoose quizapp react react-native redux-toolkit
Last synced: 7 days ago
JSON representation
Personalized English Vocabulary Learning App Built with React Native & NestJS
- Host: GitHub
- URL: https://github.com/nz-m/wordsage
- Owner: nz-m
- License: mit
- Created: 2023-07-28T21:41:49.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-10-01T20:27:30.000Z (about 1 year ago)
- Last Synced: 2023-10-01T23:43:42.782Z (about 1 year ago)
- Topics: android-application, ios-app, jwt-authentication, mongodb, mongodb-atlas, nestjs, nestjs-backend, nestjs-mongoose, quizapp, react, react-native, redux-toolkit
- Language: JavaScript
- Homepage: https://youtu.be/mM8SDkkgZN0
- Size: 2.76 MB
- Stars: 11
- Watchers: 2
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
WordSage 📚📱
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.
## 🚀 Features
- ✨ **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.
## 🛠️ Tech Stack
- ⚛️ **Frontend:** React Native, Redux Toolkit
- 🧱 **Backend:** NestJS
- 💾 **Database:** MongoDB
- 🎨 **Admin Panel:** React, Vite, and Tailwind CSS
## ⚙️ Installation
### 📋 Prerequisites
- 📦 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.
### 📝 Steps
1. **Clone the repository:**
```bash
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`, and `admin-panel`
```bash
npm install
```
3. **Create `.env` files:**
Create .env files in the `backend` and `admin-panel` directories following the format in the `.env.example` file.
4. **Setup backend URL in frontend:**
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.
5. **Start the backend server:**
```bash
npm start
```
> Access `http://127.0.0.1:4000/docs` to view the API documentation. 6. **Start the admin panel**
```bash
npm start
```
7. **Access the admin panel at `http://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 learning
> contents are stored in the `backend` directory in the `resources` folder with appropriate file names.
8. **Start the app (frontend):**
```bash
npm start
```
Scan the QR code using the Expo Go app to run the app on your mobile device.
## 📷 Screenshots
## 🤝 Contributing
Contributions are welcome. See [CONTRIBUTING.md](https://github.com/nz-m/WordSage/blob/main/CONTRIBUTING.md) for more details.
## 📬 Feedback
If you have any feedback, please reach out to me at [[email protected]](mailto:[email protected])
## 📄 License
This project is licensed under the [MIT License.](https://github.com/nz-m/WordSage/blob/main/LICENSE)