Skip to content

Latest commit

 

History

History
116 lines (74 loc) · 2.72 KB

README.md

File metadata and controls

116 lines (74 loc) · 2.72 KB
Raw

DailyJournal - Blog Site

DailyJournal is a blog site built using Node.js, Express, EJS, Mongoose, and MongoDB. It allows users to create, read, update, and delete blog posts, making it a perfect platform for sharing ideas and stories with the world.

Table of Contents

Features

  • User-friendly interface for writing and managing blog posts.
  • Supports Markdown formatting to add rich content to blog posts.
  • Admin functionality for managing blog posts and users.
  • Secure authentication using email/password or social media logins.
  • User profile management with avatar support.
  • Commenting system to engage with readers.
  • Responsive design for optimal viewing on various devices.

Requirements

Before running the application, ensure you have the following requirements met:

Installation

  1. Clone the repository:
git clone https://github.com/your-username/DailyJournal.git
cd DailyJournal
  1. Install the dependencies:
npm install

  1. Set up environment variables:

    Create a .env file in the root directory of the project and provide the necessary environment variables. For example:

    PORT=3000
MONGODB_URI=mongodb://localhost:27017/daily_journal_db
SECRET_KEY=mysecretkey

  2. Seed the database (optional):

    If you want to start with some dummy data, you can run the following command to seed the database:

    node seed.js

Usage

  1. Start the server:
npm start

  1. Visit http://localhost:3000 in your web browser to access DailyJournal.

  2. Register an account or log in if you already have one.

  3. Create, read, update, and delete blog posts from the dashboard.

  4. Interact with readers through the comments section.

  5. Enjoy sharing your thoughts and stories with the world!

Contributing

If you want to contribute to DailyJournal, follow these steps:

  1. Fork the repository.

  2. Create a new branch with a descriptive name:

git checkout -b feature/your-feature-name

  1. Make changes and test thoroughly.

  2. Commit your changes:

git commit -m "Add your commit message here"
  1. Push to your branch:
git push origin feature/your-feature-name
  1. Create a pull request.

License

MIT License

Happy blogging with DailyJournal! If you have any questions or issues, please don't hesitate to open an issue or contact us. We welcome contributions and hope you find DailyJournal a useful platform for your blogging needs!