lily4178993/nell-blog

A dynamic Ruby on Rails-based blog platform designed to showcase a curated list of posts. It encourages reader engagement through features such as the ability to add comments and express appreciation for posts by liking them.

Nell Blog

Table of Contents

• About Project
• Built With
• Tech Stack
• Key Features

• Getting Started
  • Prerequisites
  • Setup
  • Install
• Usage
• Tests
• Author
• Future Features
• Contributing
• Show your support
• Acknowledgements
• License

About Project

Nell Blog is a dynamic Ruby on Rails-based blog platform designed to showcase a curated list of posts. It encourages reader engagement through features such as the ability to add comments and express appreciation for posts by liking them.

Built With

• Ruby on Rails

Tech Stack

• Ruby
• Rails
• HTML
• CSS
• JavaScript

Key Features

• Showcase curated blog posts
• Reader engagement through comments
• Post appreciation with likes

Getting Started

Prerequisites

Ensure you have Ruby and Rails installed on your machine. If not, follow the official installation guide for Ruby and Rails.

Setup

Clone the repository to your local machine:

git clone https://github.com/lily4178993/nell-blog.git

Navigate to the project folder:

cd nell-blog

Install

1. Install Ruby Gems:

   Install project dependencies using Bundler:

   bundle install

2. Install Node.js Dependencies:

   This project has additional dependencies specified in package.json, install them using npm:

   npm install

   Or if you prefer using Yarn:

   yarn install

   This step ensures that your development environment has all the required packages.

3. Database Setup:

   Set up the database by running the following commands:

   rails db:create
   rails db:migrate

Usage

To start the Rails server, run:

rails server

Visit http://localhost:3000 in your browser to explore the Nell Blog platform.

Tests

The Nell Blog application comes with a suite of tests to ensure the reliability and correctness of its functionality.

To run all the tests for the Nell Blog application, follow these steps:

1. Run Migrations in the Test Database:

   Ensure the test database is up-to-date by migrating tables:

   rails db:migrate RAILS_ENV=test

2. Execute Tests:

   Run all tests using the following command:

   rails test

Author

Nell Blog is developed and maintained by Nelly Telli. If you have any questions, suggestions, or feedback, feel free to reach out:

• GitHub: @lily4178993
• LinkedIn: Nelly T.

Future Features

• Enhanced user authentication
• Rich text formatting for posts
• Social media integration

Contributing

Contributions are welcome! Feel free to open an issue or submit a pull request.

Show your support

If you find Nell Blog helpful, please consider starring the repository.

Acknowledgments

Special thanks to Microverse for making this project possible.

License

This project is licensed under the MIT License - see the LICENSE file for details.

(back to top)