This repository contains the source code and content for a personal blog. The blog is designed to share insights, thoughts, and experiences on various topics, including technology, programming, and personal development.
Installation
Usage
Contributing
License
To run this blog locally, please follow the steps below:
-
Clone this repository to your local machine using the following command:
git clone https://github.com/maryamrmz/blog.git
-
Install the necessary dependencies by navigating into the cloned repository and running the following command:
yarn install
-
Create a configuration file named
.env
in the root directory of the project, and provide the required environment variables. Refer to the.env.example
file for the list of variables and their descriptions. -
Start the development server by running the following command:
yarn start
This will launch the blog on a local server, and you can access it by opening your web browser and entering http://localhost:3000
.
Once the blog is up and running, you can explore the content by navigating through the different sections and blog posts. The blog offers a user-friendly interface that allows for easy browsing and reading.
You can also use the search functionality to find specific articles based on keywords or tags. Additionally, registered users have the option to leave comments on blog posts, contributing to discussions and engaging with the author and other readers.
Contributions to this blog are welcome! If you wish to contribute, please follow the guidelines below:
-
Fork this repository and clone the forked repository to your local machine.
-
Create a new branch for your feature or bug fix:
git checkout -b feature/your-feature-name
-
Make your changes, ensuring that your code follows the repository's coding style and guidelines.
-
Commit your changes with a descriptive commit message:
git commit -m "Add feature/fix: your detailed description"
-
Push your changes to your forked repository:
git push origin feature/your-feature-name
-
Open a pull request against the main branch of this repository. Provide a clear and concise description of your changes, along with any relevant information that may assist in reviewing the pull request.
-
Wait for the maintainers to review your pull request and address any requested changes.
This project is licensed under the MIT License