Skip to content

Latest commit

 

History

History
66 lines (48 loc) · 2.63 KB

README.md

File metadata and controls

66 lines (48 loc) · 2.63 KB

Byte-Bites

A MERN stack blog website for sharing articles on web development projects and technologies.

Features

  • User authentication
  • CRUD operations for articles and comments , HTML entities, Code syntax highlighting...
  • Mailchimp API integration for newsletter subscription
  • Search functionality
  • Responsive UI design

Technologies and Libraries

  • MongoDB
  • Express.js
  • React
  • Node.js
  • Passport.js
  • JWT
  • Axios

Installation

  1. Clone the repository.

  2. Run $ npm install or $ npm i in both the root directory and the client directory.

  3. Create a .env file in the root directory with the following variables:

    MONGODB_URI=<your MongoDB URI>
    JWT_SECRET=<your JWT secret>
    MAILCHIMP_API_KEY=<your Mailchimp API key>
    MAILCHIMP_LIST_ID=<your Mailchimp list ID>
  1. Run npm run dev to start the development server.

Contributing

Contributions are welcome! Feel free to submit a pull request or open an issue if you find any bugs or have suggestions for new features. See the CONTRIBUTING.md file for more information.

Contributing to Byte-Bites

Thank you for your interest in contributing to MyTechBlog! This project welcomes all types of contributions, including bug reports, feature requests, documentation improvements, and code contributions.

Before you start contributing, please take a moment to read the following guidelines.

Getting started

refer installation

Bug Reports and Feature Requests

If you find a bug in the application, please report it by opening an issue in the GitHub repository. Be sure to include a description of the bug, steps to reproduce it, and any relevant error messages. If you have a feature request, please also open an issue in the repository with a description of the feature and how it would benefit the application.

Code Contributions

If you would like to contribute code to the project, please follow these steps:

1.Create a new branch for your changes. 2.Make your changes and write tests if applicable. 3.Push your branch to your forked repository. 4.Submit a pull request to the main repository.

Please be sure to include a detailed description of your changes in the pull request, including any relevant context or reasoning.

Code Style

To maintain consistency in the codebase, please follow the existing code style and conventions. We recommend using ESLint to check your code for errors and enforce style guidelines.

License

This project is licensed under the MIT License. See the LICENSE file for more information.