-
Notifications
You must be signed in to change notification settings - Fork 50
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #53 from neeru24/patch-1
Update README.md
- Loading branch information
Showing
1 changed file
with
94 additions
and
33 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,50 +1,111 @@ | ||
<div align="center"> | ||
# BlogLog 📝 | ||
|
||
# BlogLog | ||
Welcome to **BlogLog**, your personalized blogging companion designed to help you effortlessly keep track of your thoughts, experiences, and reflections all in one convenient log. Built with **Node.js**, **Express**, and **MongoDB**, BlogLog provides a user-friendly interface to create, read, update, and delete (CRUD) your blog posts. | ||
|
||
<i>Welcome to BlogLog, your personalized blogging companion tailored to keep track of your thoughts, experiences, and reflections in one convenient log. This application is built with Node.js, Express, and MongoDB, making it easy for you to create, read, update, and delete (CRUD) your blog posts.</i> | ||
<table align="center"> | ||
<thead align="center"> | ||
<tr border: 2px;> | ||
<td><b>🌟 Stars</b></td> | ||
<td><b>🍴 Forks</b></td> | ||
<td><b>🐛 Issues</b></td> | ||
<td><b>🔔 Open PRs</b></td> | ||
<td><b>🔕 Close PRs</b></td> | ||
</tr> | ||
</thead> | ||
<tbody> | ||
<tr> | ||
<td><img alt="Stars" src="https://img.shields.io/github/stars/jinx-vi-0/BlogLog?style=flat&logo=github"/></td> | ||
<td><img alt="Forks" src="https://img.shields.io/github/forks/jinx-vi-0/BlogLog?style=flat&logo=github"/></td> | ||
<td><img alt="Issues" src="https://img.shields.io/github/issues/jinx-vi-0/BlogLog?style=flat&logo=github"/></td> | ||
<td><img alt="Open Pull Requests" src="https://img.shields.io/github/issues-pr/jinx-vi-0/BlogLog?style=flat&logo=github"/></td> | ||
<td><img alt="Close Pull Requests" src="https://img.shields.io/github/issues-pr-closed/jinx-vi-0/BlogLog?style=flat&color=critical&logo=github"/></td> | ||
</tr> | ||
</tbody> | ||
</table> | ||
|
||
</div> | ||
## Key Features 🌟 | ||
|
||
<div align="center"> | ||
- **📝 Create New Blog Posts**: Easily compose and publish your thoughts. | ||
- **👁️ Read & View**: Browse through your blog posts with a simple and intuitive design. | ||
- **✏️ Update Posts**: Modify existing blog entries to reflect your current thoughts. | ||
- **❌ Delete Posts**: Remove any blog posts you no longer wish to keep. | ||
- **📱 Responsive Design**: Enjoy a seamless experience across all devices. | ||
- **🖱️ User-Friendly Interface**: Navigate effortlessly with an easy-to-use interface. | ||
|
||
## -> Key Features <- | ||
</div> | ||
## Installation 🚀 | ||
|
||
To get started with BlogLog, follow these steps: | ||
|
||
1. **Clone the Repository**: | ||
```bash | ||
git clone https://github.com/yourusername/bloglog.git | ||
cd bloglog | ||
``` | ||
|
||
2. **Install Dependencies**: | ||
```bash | ||
npm install | ||
``` | ||
|
||
3. Set Up Environment Variables: | ||
|
||
Create a `.env` file in the root directory and add the following line: | ||
```bash | ||
MONGODB_URI=mongodb://localhost:27017/bloglog | ||
``` | ||
|
||
4. Start the Server: | ||
```bash | ||
npm start | ||
``` | ||
|
||
- **Create** new blog posts. | ||
- **Read** and view individual blog posts. | ||
- **Update** existing blog posts. | ||
- **Delete** blog posts. | ||
- **Responsive design** for a seamless experience on any device. | ||
- **User-friendly interface** for easy navigation and interaction. | ||
The application will be available at `http://localhost:5000` 🌐 | ||
|
||
## Installation | ||
## Usage 🛠️ | ||
After starting the server, open your browser and navigate to `http://localhost:5000`. From there, you can create, view, update, and delete your blog posts. | ||
|
||
1. **Clone the repository:** | ||
## Contributing 🤝 | ||
We welcome contributions! Here’s how you can contribute: | ||
|
||
```bash | ||
git clone https://github.com/yourusername/bloglog.git | ||
cd bloglog | ||
``` | ||
1. **Fork the Repository**: Create a personal copy of the repository on your GitHub account. | ||
|
||
2. **Install dependencies:** | ||
2. **Create Your Branch**: Develop your feature or fix. | ||
```bash | ||
git checkout -b feature/YourFeatureName | ||
``` | ||
|
||
```bash | ||
npm install | ||
``` | ||
3. **Commit Your Changes**: Make sure to write meaningful commit messages. | ||
```bash | ||
git commit -m "Add some feature" | ||
``` | ||
|
||
3. **Set up environment variables:** | ||
4. **Open a Pull Request**: Push your changes to your fork and submit a pull request. | ||
|
||
Create a `.env` file in the root directory and add the following: | ||
5. Add Detailed Descriptions: Include any relevant information and screenshots if applicable. | ||
|
||
```env | ||
MONGODB_URI=mongodb://localhost:27017/bloglog | ||
``` | ||
|
||
4. **Start the server:** | ||
## License 📜 | ||
This project is licensed under the [MIT License](LICENSE) | ||
|
||
## Acknowledgments 🙌 | ||
|
||
- Thanks to the open-source community for their valuable resources. | ||
- Special thanks to the contributors who have made this project better. | ||
|
||
|
||
## Our Contributors 👀 | ||
|
||
- We extend our heartfelt gratitude for your invaluable contribution to our project! Your efforts play a pivotal role in elevating Ratna-Supermarket to greater heights. | ||
- Make sure you show some love by giving ⭐ to our repository. | ||
|
||
<div> | ||
|
||
<a href="https://github.com/jinx-vi-0/BlogLog"> | ||
<img src="https://contrib.rocks/image?repo=jinx-vi-0/BlogLog&&max=1000" /> | ||
</a> | ||
</div> | ||
|
||
```bash | ||
npm start | ||
``` | ||
## Give it a Star! ⭐ | ||
#### If you enjoy BlogLog, give this repository a star! ⭐ | ||
|
||
The application will be available at `http://localhost:5000`. | ||
### Enjoy using BlogLog, and happy blogging! 🌈 |