Skip to content

Commit 0fb9228

Browse files
Updated Readme
1 parent 9f4078c commit 0fb9228

File tree

1 file changed

+98
-0
lines changed

1 file changed

+98
-0
lines changed

README.md

Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
# **Dev-Blogs**
2+
3+
[![License](https://img.shields.io/github/license/ekrishnachaitanya2004/dev-blogs?style=flat-square)](LICENSE)
4+
[![Issues](https://img.shields.io/github/issues/ekrishnachaitanya2004/dev-blogs?style=flat-square)](https://github.com/ekrishnachaitanya2004/dev-blogs/issues)
5+
[![Forks](https://img.shields.io/github/forks/ekrishnachaitanya2004/dev-blogs?style=flat-square)](https://github.com/ekrishnachaitanya2004/dev-blogs/network/members)
6+
[![Stars](https://img.shields.io/github/stars/ekrishnachaitanya2004/dev-blogs?style=flat-square)](https://github.com/ekrishnachaitanya2004/dev-blogs/stargazers)
7+
8+
## **Introduction**
9+
10+
**Dev-Blogs** is an open-source blogging platform aimed at developers and tech enthusiasts. It allows contributors to write and share blogs about various technical topics, including programming, open-source software, and emerging technologies. This project encourages community collaboration by allowing developers to fork the repository, submit blog posts, and contribute to the platform's development.
11+
12+
## **Key Features**
13+
14+
- **Contribute Blog Posts**: Share your knowledge and experiences by submitting technical blogs.
15+
- **Fully Responsive**: Dev-Blogs is designed to work seamlessly across all devices.
16+
- **Customizable Themes**: Switch between light and dark themes for a better user experience.
17+
- **TailwindCSS for Styling**: Clean and flexible CSS framework for easy customization.
18+
- **SEO Optimized**: Ensures better visibility on search engines, increasing the reach of your content.
19+
- **Open Source**: Free to use and contribute under the MIT license.
20+
21+
## **How to Contribute**
22+
23+
Contributing to Dev-Blogs is simple and open to everyone! Follow these steps to submit your own blog posts or improve the project:
24+
25+
1. **Fork the Repository**: Click on the fork button at the top-right of this page to create a copy of the project on your GitHub account.
26+
2. **Clone the Forked Repository**: Clone the repository to your local machine.
27+
```bash
28+
git clone https://github.com/ekrishnachaitanya2004/dev-blogs
29+
```
30+
3. **Create a New Branch**:
31+
```bash
32+
git checkout -b my-new-feature
33+
```
34+
4. **Make Your Changes**: Add your blog post, fix bugs, or add new features.
35+
5. **Commit Your Changes**: Use descriptive commit messages.
36+
```bash
37+
git commit -m "Add: New blog"
38+
```
39+
6. **Push to GitHub**: Push your changes to your forked repository.
40+
```bash
41+
git push origin my-new-feature
42+
```
43+
7. **Submit a Pull Request**: Go to the original repository and submit a pull request with a detailed description of your changes.
44+
45+
For more details, please refer to the **[CONTRIBUTING.md](CONTRIBUTING.md)** guide.
46+
47+
## **Installation Instructions**
48+
49+
To run the project locally, follow these steps:
50+
51+
1. **Clone the Repository**:
52+
```bash
53+
git clone https://github.com/eksandy/dev-blogs.git
54+
```
55+
2. **Navigate to the Project Directory**:
56+
```bash
57+
cd dev-blogs
58+
```
59+
3. **Install Dependencies**:
60+
```bash
61+
npm install
62+
```
63+
4. **Run the Development Server**:
64+
```bash
65+
npm run dev
66+
```
67+
5. Open your browser and navigate to `http://localhost:3000`.
68+
69+
## **Project Structure**
70+
71+
```plaintext
72+
dev-blogs/
73+
├── content/ # Contains all the blog posts
74+
├── public/ # Public assets like images
75+
├── src/ # Main source code for the website
76+
│ ├── components/ # Reusable components (e.g., Navbar, Footer)
77+
│ ├── pages/ # Website pages (e.g., Home, About)
78+
│ └── styles/ # Custom styling for the website
79+
├── .gitignore # Ignored files for Git
80+
├── LICENSE # License for the project
81+
├── README.md # Project overview (this file)
82+
└── package.json # Project dependencies and scripts
83+
```
84+
85+
## **Contributors**
86+
87+
We appreciate all contributions to **Dev-Blogs**! You can see the full list of contributors [here](https://github.com/eksandy/dev-blogs/graphs/contributors).
88+
89+
## **License**
90+
91+
This project is licensed under the MIT License. See the **[LICENSE](LICENSE)** file for more details.
92+
93+
## **Contact**
94+
95+
If you have any questions or want to get involved, feel free to reach out to us through:
96+
97+
- GitHub Issues: [Submit a question or issue](https://github.com/ekrishnachaitanya2004/dev-blogs/issues)
98+

0 commit comments

Comments
 (0)