https://github.com/prkbuilds/vocabulary-app

https://github.com/prkbuilds/vocabulary-app

portfolio

Last synced: 29 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/prkbuilds/vocabulary-app
• Owner: prkbuilds
• Created: 2022-04-18T06:36:23.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-04-18T10:12:03.000Z (over 2 years ago)
• Last Synced: 2024-11-15T20:37:37.806Z (about 1 month ago)
• Topics: portfolio
• Language: JavaScript
• Homepage: https://vocabulary-app-sage.vercel.app
• Size: 526 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Vocabulary-App



    



The 🕸️Web-App is deployed on 🌟[Heroku](https://vocabulary-app-01.herokuapp.com)

## 📚 About

Vocabulary app for storing selective words in Dictionary & searching them according to need.

## ⚙️ Functionalities



    
Store Words with Origin, Definitions & Examples

    
Make calls to Oxford Dictionary API for new word data.

    
Allow users to search for selected words.



## 🔧 Installation

Just Download the files, and run

```bash

npm i

cd client

npm i

```

for installation of all packages in both ``server`` and ``client`` folders.

## 🔌 Usage

For Server, create a `.env` file and store all the environmental vairiables for Oxford Dictionary API & MongoDB Variables.

Then run the following commands

```bash

npm run dev-start

```

For Client, create a `.env` file and store the environmental vairiable for server port.

just run the following commands to run the react application

```bash

cd client

npm start

```

## ⭐ Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.