README.md

GRE-Vocabulary-Builder

GRE-Vocabulary-Builder is a web based app built for GRE learners. The whole idea for this application is to build a personal library of words and create different practise session to practise those words. The app is built using the MERN stack, and is still in the development phase.

Features:

• Users can pull new words from internet and add it to their library
• Create a practise session to practise words from user's library
• Keep tracks of number of times user solves a problem

How to run the application (currently in local):

• First, clone the application using git clone <Repo_URL>
• Navigate to the cloned folder
• Set up out backend
  • Set up local environment:
    • First, create a .env file
    • Go to mongodb atlas and make a mongodb atlas instance using free tire. For more info you can visit https://docs.atlas.mongodb.com/getting-started/
    • Get a mongogb atlas URI string to connect to the cloud database. Add the string in .env file as DB_String=<Your_URI_String>
    • Similarly, we need an API key for Words API from rapid API. You can learn more about the API at https://docs.rapidapi.com/docs and https://rapidapi.com/dpventures/api/wordsapi/details
    • The details about API user and key should be added in .env file. For example: WORD_API_USER=<YOUR_API_USER> and WORD_API_KEY=<YOUR_API_KEY>
  • Run npm install to install essential packages
  • Run node app.js to run the application for the backend. Yay! your backend is running.
• Set up Frontend
  • Just run npm install after navigating inside the client folder
  • Then run npm start and the client will be running in port 3000. You can open the brower and navigative to http://localhost:3000 to use it.

Improvements to make:

• Currently, we are working to handle multiple users. It was a personal project for a friend so initially we didn't think to support multiple users.
• Build an algorithm to display words according to attempts and corrects/attempts ratio for better studying experience

How to contribute:

• First, fork the repo
• Set up your local environment
• Make a new branch and checkout to your branch using git checkout -b "branch_name"
• Make your suggested changes
• Add your commit and changes using git add . && git commit -m "your commit message"
• then push the chnages into your branch git push origin branch_name
• Now you can create a PR using the branch in your repo

Sometimes there might be additional commit merged in the master or main branch after you fork the repo. This might result in merge conflict. In that case need to rebase and issue the PR.

Rebasing steps:

• Add an upstream remote using git remote add upstream <main_repo_url>
• Checkout to main branch and pull the latest updates from upstream using git pull upstream
• Once the main branch is up-to-date checkout to your branch and rebase it using git rebase main
• If there is any merge conflict resolve them, commit them and continue rebase using git rebase --continue
• Push the changes to your repo and issue the PR