https://github.com/alejandroq12/word-keeper
"Word Keeper" is a dynamic web application designed to help language learners expand their vocabulary. Users can create a personal repository of new words along with their meanings to revisit and reinforce learning.
https://github.com/alejandroq12/word-keeper
Last synced: 4 days ago
JSON representation
"Word Keeper" is a dynamic web application designed to help language learners expand their vocabulary. Users can create a personal repository of new words along with their meanings to revisit and reinforce learning.
- Host: GitHub
- URL: https://github.com/alejandroq12/word-keeper
- Owner: Alejandroq12
- License: mit
- Created: 2022-12-01T00:56:37.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-04-29T20:22:43.000Z (about 2 years ago)
- Last Synced: 2025-04-04T05:51:09.550Z (26 days ago)
- Language: JavaScript
- Homepage:
- Size: 186 KB
- Stars: 13
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Word Keeper
Word Keeper
## Description
## Project Description
"Word Keeper" is a dynamic web application designed to help language learners expand their vocabulary. Users can create a personal repository of new words along with their meanings to revisit and reinforce learning.
The application is built with the MERN stack (MongoDB, Express.js, React.js, and Node.js), providing an intuitive user interface and a reliable backend service. Users can add, update, and delete words as they progress in their language journey.
This project exemplifies the practical use of React Hooks and CRUD operations in a full-stack JavaScript environment. The minimalist design and fluid animations further enhance the user experience, making vocabulary learning more engaging and fun.
Whether you're a language enthusiast looking to track new vocabulary or a developer seeking inspiration for MERN stack projects, Word Keeper serves as a great resource.
## Getting Started
### Prerequisites
Before you begin, ensure you have met the following requirements:
- You have installed Node.js and npm/yarn.
- You have a Windows/Mac/Linux machine.
### Clone the repository
git clone https://github.com/Alejandroq12/word-keeper.git
### Installing
For installation, follow these steps:
#### Backend
1. Navigate to the backend directory of the project.
2. Run `npm install` or `yarn` to install all dependencies.
3. Rename `.env.example` to `.env` and fill in your environment variables.
4. Run `npm start` or `yarn start` to start the server.
#### Frontend
1. Navigate to the frontend directory of the project.
2. Run `npm install` or `yarn` to install all dependencies.
3. Run `npm start` or `yarn start` to start the application.
#### For the server-side part:
1. Navigate to the root directory of the whole project.
```bash
npm install
```
## MongoDB Setup
This project uses MongoDB as its database. Follow these steps to setup:
1. Install MongoDB on your machine, or setup a MongoDB Atlas cluster.
2. Obtain the connection string for your MongoDB database.
3. Creat the `.env` file backend/ with your MongoDB connection string MONGODB_URI=mongodb+srv://:@.mongodb.net/test
#### Run the project
```
cd backend
npm start
```
```
cd frontend
npm start
```
## Usage
Once both the frontend and backend servers are running, navigate to `http://localhost:` in your browser to access the application.
## Contribution
If you want to contribute to this project, follow these steps:
1. Fork the repository.
2. Create a new branch.
3. Make your changes and commit them.
4. Push your changes to your fork.
5. Submit a pull request.
## Contact
If you want to contact me, you can reach me at `[email protected]`.
## License
This project is [LICENSE](./LICENSE) licensed.