Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cancelei/blog-in-rails
Learning to code in Ruby on Rails, while participating in Microverse Remote School.
https://github.com/cancelei/blog-in-rails
Last synced: 18 days ago
JSON representation
Learning to code in Ruby on Rails, while participating in Microverse Remote School.
- Host: GitHub
- URL: https://github.com/cancelei/blog-in-rails
- Owner: cancelei
- License: mit
- Created: 2023-10-05T18:15:52.000Z (about 1 year ago)
- Default Branch: dev
- Last Pushed: 2023-10-21T18:37:20.000Z (about 1 year ago)
- Last Synced: 2024-10-10T08:42:47.774Z (about 1 month ago)
- Language: Ruby
- Size: 318 KB
- Stars: 4
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Blog in Rails App
[](https://codecov.io/gh/cancelei/blog-in-rails)
# 📗 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)
- [Deployment](#deployment)
- [👥 Authors ](#-authors-)
- [🔭 Future Features ](#-future-features-)
- [🤝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [🙏 Acknowledgments ](#-acknowledgments-)
- [❓ FAQ (OPTIONAL) ](#-faq-optional-)
- [📝 License ](#-license-)
**Blog in Rails App** empowers the end-users to start a new blog-post, comment and like existing content.
> So you want to lear more about the tech we have used for this project?
Server
Database
- **Make use for migrations features from Active Record**
- **Include Tables for User, Comment, Post, and Like**
- **Use user authentification and authorizations**
To get a local copy up and running, follow these steps.
Note: We are assuming you have pre-installed ruby, WSL, ubuntu and rails!
### Prerequisites
In order to run this project you need:
first at all, install rails:
```sh
gem install rails
```
### Setup
Clone this repository to your desired folder:
```sh
cd my-folder
[email protected]:cancelei/blog-in-rails.git
```
### Install
Install this project with:
```sh
cd blog-app
bundle install
```
Setting up the Data Base:
```sh
rails db:create
rails db:migrate
rails db:seed
```
### Usage
To run the project, execute the following command:
```sh
rails server
```
### Run tests
Before running tests, ensure you've set up the test database:
```sh
bin/rails db:migrate RAILS_ENV=test
```
**Note:** Given that the aim of this project is to test the application's UI, to see if it works without side effects. We have therefore had to modify the contents of certain files, which could have the effect of falsifying certain `Unit` tests.
We therefore recommend that, rather than running all the tests, you only test the `features` folder and run
```sh
bundle exec rspec ./spec/features
```
### Deployment
The deployment will be available soon !
👤 **Glauber Bannwart**
- GitHub: [@cancelei](https://github.com/cancelei)
- LinkedIn: [Glauber Bannwart](https://www.linkedin.com/in/gbannwart/)
👤 **Najibullah Jafari**
- GitHub: [Najibullah_jafari](https://github.com/najibullahjafari)
- Twitter: [Najibullah_jafari](https://twitter.com/Najib_Jafari_)
- LinkedIn: [Najibullah_jafari](https://www.linkedin.com/in/najibullahjafari/)
👤 **Joseph L Kausi**
- GitHub: [@Grandi0z](https://github.com/Grandi0z)
- Twitter: [@Joseph_LSK](https://twitter.com/Joseph_LSK)
- LinkedIn: [Joseph L Kausi](https://www.linkedin.com/in/joskal/)
> We this project can improve, we are planning to include the next features soon:
- [x] **User Interface**
- [x] **Validations**
- [ ] **API documentation**
- [x] **Model Data**
- [x] **Controllers Testing**
- [x] **Models Testing**
- [x] **View Implementation**
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/cancelei/blog-in-rails/issues).
> Would you like to help?
If you like this project feel free to leave an start, as well if you have a suggestion feel free to visit issues page.
I would like to thank Microverse for suggestion this project.
> Learn more about FAQ below:
- **How do I fix Linters errors if I modify the project?**
- for rubocop run
```sh
rubocop -A
```
- for Stylint run:
```sh
npx stylelint "**/*.{css,scss}" --fix
```
This project is [MIT](./LICENSE) licensed.