MERN-Mates

Blog Website

An Awesome Blog website using MERN stack

Explore the docs »

View Demo . Report Bug . Request Feature

Table Of Contents

• About the Project
• Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Authors
• Acknowledgements

About The Project

There are many great README templates available on GitHub, however, I didn't find one that really suit my needs so I created this enhanced one. I want to create a README template so amazing that it'll be the last one you ever need.

Here's why:

• Your time should be focused on creating something amazing. A project that solves a problem and helps others
• You shouldn't be doing the same tasks over and over like creating a README from scratch
• You should element DRY principles to the rest of your life :smile:

Of course, no one template will serve all projects since your needs may be different. So I'll be adding more in the near future. You may also suggest changes by forking this repo and creating a pull request or opening an issue.

A list of commonly used resources that I find helpful are listed in the acknowledgements.

Built With

MERN stack is used in building this website

• Mongodb
• React js
• Express Js
• Mongoose
• Node js
• React-router-dom @v6

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• npm
• Nodejs

Installation

1. Fork the repository

2. Clone the repo

git clone https://github.com/your_username_/Project-Name.git

3.cd to frontend folder

cd frontend

4. Install NPM packages

npm install

5. Run the app on your local machine

npm start

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

Roadmap

See the [open issues](https://github.com/ MERN-Mates/alokVerma749 / MERN-Mates Public/issues) for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

• If you have suggestions for adding or removing projects, feel free to [open an issue](https://github.com/ MERN-Mates/alokVerma749 / MERN-Mates Public/issues/new) to discuss it, or directly create a pull request after you edit the README.md file with necessary changes.
• Please make sure you check your spelling and grammar.
• Create individual PR for each suggestion.
• Please also read through the [Code Of Conduct](https://github.com/ MERN-Mates/alokVerma749 / MERN-Mates Public/blob/main/CODE_OF_CONDUCT.md) before posting your first idea as well.

Creating A Pull Request

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See [LICENSE](https://github.com/ MERN-Mates/alokVerma749 / MERN-Mates Public/blob/main/LICENSE.md) for more information.

Authors

• Alok Kumar Verma - Comp Science Student - Alok Kumar Verma - **
• You will be the next - - You will be the next -

Acknowledgements

• Alok Kumar Verma
• [you are the next]()
• []()