Update README & CONTRIBUTING

CONTRIBUTING.md

@@ -6,39 +6,61 @@ The following is a set of guidelines for contributing to WordSage.
 
 ## Table of Contents
 
-1. How Can I Contribute?
-2. I have a question!
-3. I found a bug!
-4. I have a great idea!
-5. Contributors
+1. Getting Started
+2. How Can I Contribute?
+3. I have a question!
+4. I found a bug!
+5. I have a great idea!
+6. Contributors
+
+## Getting Started
+
+- Fork the repository on GitHub.
+- Clone the forked repository to your local machine.
+- Follow the installation instructions in the [README.md](https://github.com/nz-m/WordSage/blob/main/README.md) file.
+- Create a new branch for your feature or bug fix.
+- Make your changes and commit them with clear and concise messages.
+- Push your changes to your forked repository.
+- Submit a pull request to the `main` branch of the original repository.
+
+### Code Style
+
+- Follow the existing code style and conventions.
+- Ensure your code is well-commented, and variable/method names are descriptive.
 
 ## How Can I Contribute?
 
 ### Incomplete Minor Features:
+
 There are some minor features that are still incomplete and could use your expertise.
 
 ### New Features:
+
 Contributions for new features are more than welcome. If you have any ideas or would like suggestions, feel free to discuss them.
 
 ### Bug Fixes:
+
 There are several bugs and issues that need attention. Your contributions in identifying and fixing these would be highly valuable.
 
 ### Optimizations:
+
 If you're interested in performance, optimizing queries, and improving the efficiency of certain processes would be appreciated.
 
 ### Code Refactoring:
+
 There might be areas of the codebase that could benefit from refactoring. Your insights and improvements in code structure would be valuable.
 
 ### UI Improvements:
+
 Enhancing the user interface is always a good way to contribute. If you have design suggestions or improvements, they would be considered.
 
 ### Documentation:
+
 Documentation is always a good way to contribute. If you have any ideas or would like suggestions, feel free to discuss them.
 
 ### Testing:
-Testing is always a good way to contribute. If you have any ideas or would like suggestions, feel free to discuss them.
-
 
+Testing is always a good way to contribute. If you have any ideas or would like suggestions, feel free to discuss them.
 
 ## I have a question!
 
@@ -60,7 +82,6 @@ Please check the
 if the idea has already been proposed. If not, please file a new one with the
 [`feature request` issue label](https://github.com/nz-m/WordSage/issues).
 
-
 ## Contributors To This Repository
 
 In order of first commit contribution.

README.md

@@ -2,13 +2,11 @@
   <h1>WordSage 📚📱</h1>
 </div>
 
-
 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.
+- ✨ **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.
@@ -39,6 +37,7 @@ WordSage is a personalized English vocabulary learning app built with React Nati
    ```bash
    git clone https://github.com/nz-m/WordSage.git
 
+   ```
 
 2. **Install dependencies:**
 
@@ -54,26 +53,29 @@ npm install
    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**
+
+> 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.
+
+   > 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.
-
-
 
+Scan the QR code using the Expo Go app to run the app on your mobile device.
 
 ## 📷 Screenshots
 
@@ -104,19 +106,9 @@ Scan the QR code using the Expo Go app to run the app on your mobile device.
   <img src="screenshots/Admin-panel.png" alt="Admin Panel">
   <img src="screenshots/Manage-questions.png" alt="Manage Questions">
 
-
-
-
-
-
 ## 🤝 Contributing
 
-Contributions are welcome! Feel free to submit a Pull Request.
-
-## 🧑‍💻 Authors
-
-- [Neaz Mahmud](https://github.com/nz-m)
-- [Hasibul Hasan Nirob](https://github.com/hasibulhasannirob)
+Contributions are welcome. See [CONTRIBUTING.md](https://github.com/nz-m/WordSage/blob/main/CONTRIBUTING.md) for more details.
 
 
 ## 📬 Feedback
@@ -126,5 +118,3 @@ If you have any feedback, please reach out to me at [[email protected]](mailto:
 ## 📄 License
 
 This project is licensed under the [MIT License.](https://github.com/nz-m/WordSage/blob/main/LICENSE)
-
-