Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kidd254/blogapp
The Blog App is a Ruby on Rails App that is meant to display a list of posts and users, display a list of users and their details, and display posts. With the role of an admin a user can delete comments and posts, but for a regular user they can only delete their posts and comments
https://github.com/kidd254/blogapp
mvc-framework postgresql rspec-testing ruby ruby-on-rails
Last synced: 27 days ago
JSON representation
The Blog App is a Ruby on Rails App that is meant to display a list of posts and users, display a list of users and their details, and display posts. With the role of an admin a user can delete comments and posts, but for a regular user they can only delete their posts and comments
- Host: GitHub
- URL: https://github.com/kidd254/blogapp
- Owner: Kidd254
- License: mit
- Created: 2023-09-27T12:59:41.000Z (about 1 year ago)
- Default Branch: dev
- Last Pushed: 2024-03-03T14:52:31.000Z (9 months ago)
- Last Synced: 2024-03-03T15:27:08.244Z (9 months ago)
- Topics: mvc-framework, postgresql, rspec-testing, ruby, ruby-on-rails
- Language: Ruby
- Homepage:
- Size: 239 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Blog App | Ruby on Rails Project
# 📗 Table of Contents
- [📗 Table of Contents](#-table-of-contents)
- [Blog App ](#blog-app-)
- [🛠 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"** is a website built with Ruby on Rails and PostgreSQL that allows users to create and publish posts, write comments, and like posts.
---
Backend
Frontend
- Ruby on Rails framework
-
Use Linters to check code quality
- Rubocop
- Stylelint
- MVC architectural/design pattern
- Data persistent in PostgreSQL
- Test the application with rspec
- Follow Microverse's list of best practices
---
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need:
A code editor (we recommend Visual Studio Code)
Git and a GitHub account
### Setup
Clone this repository to your desired folder by using this 👇️ command :
```
git clone https://github.com/Kidd254/BlogApp.git
```
### Install
Go to the project directory:
```
cd blog-app
```
Before to run the program, verify that you have Ruby on Rails installed on your OS running the following command:
```
rails --version
```
It should show you the version of ruby on rails installed. If this does not happen and only an error message is displayed, then you should either verify your installation or install Ruby on Rails from scratch.
[Download and Install Ruby on Rails](https://guides.rubyonrails.org/getting_started.html)
### Usage
Run the following command inside the project folder to start the application:
```
rails s
```
This will start the application on your local server. You can now open your browser and go to http://localhost:3000/ to see the application running.
### Run tests
To execute the tests, run the following command inside the project folder:
```
rspec
```
---
👤 **Lawrence Muema Kioko**
- GitHub: [@kidd254](https://github.com/Kidd254)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/lawrence-muema-kioko)
---
Upcoming improvements:
- [x] Creating a data model
- [x] Processing data in models
- [x] Validations and model specs
- [x] Controllers
- [x] Views
- [ ] Forms
---
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/NitBravoA92/blog-app/issues).
---
If you like this project and know someone who might find it helpful, please share it.
Or give it a **star** ⭐️ if you like this project!
---
I thank Microverse for this fantastic opportunity, and the code reviewers for their advice and time.
---
This project is [MIT](./LICENSE) licensed.
---