Skip to content

Latest commit

 

History

History
127 lines (83 loc) · 4.17 KB

README.md

File metadata and controls

127 lines (83 loc) · 4.17 KB

GitHub release (latest by date) GPLv3 License GitHub issues Netlify Status

Logo

MERN Oxford Dictionaries

A dictionary PWA built with MERN stack using Oxford Dictionaries API

View DemoReport BugRequest Feature

Screenshots

ace search suggestions drawer light drawer dark abeyance history bookmarks desktop search suggestions

Features

  • Definitions
  • History
  • Bookmarks
  • Light/dark mode toggle
  • PWA (Progressive Web App)

Run Locally

Clone the project

  git clone https://github.com/MobinurRahaman/mern-oxford-dictionaries.git

Go to the project directory

 cd mern-oxford-dictionaries

Go to the client directory

  cd client

Install dependencies

  yarn install

Create a .env file

Set environment variable as mentioned below

Start the React server

  yarn start

open a new terminal window

Go back to the root project directory

Go to the server directory

  cd server

Install dependencies

  yarn install

Create a .env file

Set environment variables as mentioned below

Run the Node server

  yarn start

Open a browser and go to http://localhost:3000

Environment Variables

To run this project, you will need to add the following environment variables to your

client/.env file

REACT_APP_SERVER_BASE_URL

server/.env file

FRONTEND_URL

APP_ID

APP_KEY

MONGODB_URL

Built with

  • React
  • NodeJS
  • Express.js
  • MongoDB
  • JavaScript
  • CSS3

License

Distributed under the GPL-3.0 License. See LICENSE for more information.