Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/nelofarzabi/blog_app_rails


https://github.com/nelofarzabi/blog_app_rails

Last synced: 26 days ago
JSON representation

Awesome Lists containing this project

README

        

# 📗 Table of Contents

- [📗 Table of Contents](#-table-of-contents)
- [TDD](#tdd)
- [Built With](#built-with)
- [Tech Stack ](#tech-stack-)
- [Key Features ](#key-features-)
- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Authors](#authors)
- [🔭 Future Features ](#-future-features-)
- [🤝 Contributing](#-contributing)
- [Show your support](#show-your-support)
- [Acknowledgments](#acknowledgments)
- [📝 License](#-license)

# Blog App

**Blog App** is a classic example of a blog website. It is a fully functional website that shows the list of posts and empowers readers to interact with them by adding comments and liking posts.

## Built With

- Ruby on Rails

### Tech Stack

Server

Database

### Key Features

> Some useful features

- **Create Ruby on Rails project**
- **Project 1: Creating a data model.**
- **Project 2: Validations and Model specs.**
- **Project 3: Processing data in models.**
- **Project 4: Setup and controllers.**
- **Project 5: Controllers specs.**
- **Project 6: Views.**
- **Project 7: Forms.**
- **Project 8: Integration specs for Views and fixing n+1 problems.**
- **Project 9: Add Devise.**
- **Project 10: Add authorization rules.**
- **Project 11: Add API endpoints.**

## Getting Started

To get a local copy up and running follow these simple example steps.

### Prerequisites
In order to run this project you need:

- GitHub account;
- Git installed on your OS;
- VSCode (or another code editor);
- [Ruby](https://www.ruby-lang.org/en/documentation/installation/) installed;
- rails 7 installed

### Setup
- Clone the repository
- Open the project folder in Visual Studio Code

### Install

Install this project using:

- cd project/directory
- Git clone [Blog app](https://github.com/Nelofarzabi/blog_app_rails.git)
-

```sh
cd blog_app_rails
bundle install
```

### Usage

To run the project, execute the following command:

- In the terminal run `rails server` file
- Go to `localhost:3000`

### Run tests

To run tests, run the following command:
`rspec spec/solver_spec.rb`

You can also check linter errors by running these commands:
`rubocop`

(back to top)

## Authors
👤 **Nelofar Zabi**

- GitHub: [@githubhandle](https://github.com/Nelofarzabi)
- Twitter: [@twitterhandle](https://twitter.com/NelofarZabi)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/nelofar-zabi-1a1066213)

## 🔭 Future Features

- [ ] **UI**

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/Nelofarzabi/blog_app_rails/issues).

## Show your support

Give a ⭐️ if you like this project!

## Acknowledgments

- Thanks to the Microverse team for the great curriculum.
- Thanks to the Code Reviewer(s) for the insightful feedback.
- A great thanks to My coding partner(s), morning session team, and standup team for their contributions.

## 📝 License

This project is [MIT](./LICENSE) licensed.