Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ahzamir/blog-app
Blog on Rails is a classic example of a blog website. You can show the list of posts and empower readers to interact with them by adding comments and liking posts. Schema
https://github.com/ahzamir/blog-app
javascript nodejs rspec rspec-rails ruby ruby-on-rails
Last synced: 26 days ago
JSON representation
Blog on Rails is a classic example of a blog website. You can show the list of posts and empower readers to interact with them by adding comments and liking posts. Schema
- Host: GitHub
- URL: https://github.com/ahzamir/blog-app
- Owner: ahzamir
- Created: 2022-08-24T09:23:12.000Z (over 2 years ago)
- Default Branch: dev
- Last Pushed: 2022-09-10T14:40:45.000Z (over 2 years ago)
- Last Synced: 2024-11-11T07:58:53.547Z (3 months ago)
- Topics: javascript, nodejs, rspec, rspec-rails, ruby, ruby-on-rails
- Language: Ruby
- Homepage:
- Size: 164 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Blog on Rails
> Blog on Rails is a classic example of a blog website. You can show the list of posts and empower readers to interact with them by adding comments and liking posts.
## Schema
## Built With
- [x] Programming Language: [Ruby](https://www.ruby-lang.org/en/)
- [x] Framework: [Ruby on Rails](https://rubyonrails.org/)
- [x] Linter: [Rubocop](https://rubocop.org/)
- [x] Code Editor: [VS Code](https://code.visualstudio.com/)
- [x] Database: [PostgreSQL](https://www.postgresql.org/)
## Getting Started
To get a local copy up and running follow these simple example steps.
### Install
In the terminal, go to your file directory and run this command.
```
$ git clone https://github.com/ahzamir/blog-app.git
```
### Usage
```
$ cd blog-app
```
```
$ rails server
```
### Setup
```
$ bundle install
```
```
$ rubocop .
```
### Run tests
To install rspec, in the terminal kindly run this command
```
$ gem install rspec
```
To run tests, please run this command
```
$ rspec ./spec/#{filename}_spec.rb
```
### API Documentation
Ypu can find the API documentation by:
```
$ rails server
```
Then go to this link: [http://localhost:3000/api-docs/index.html](http://localhost:3000/api-docs/index.html)
### Prerequisites
- [x] A web browser like [Google Chrome](https://www.google.com/chrome/).
- [x] A code editor like [Visual Studio Code](https://code.visualstudio.com/).
- [x] A terminal to run the code.
- [x] [Ruby](https://www.ruby-lang.org/en/) installed on your computer.
- [x] [Rails](https://rubyonrails.org/) installed on your computer.
You can check if Git is installed by running the following command in the terminal.
```
$ git --version
```
Likewise for Ruby installation.
```
$ ruby --version && irb
```
To install rails, in the terminal kindly run this command
```
$ gem install rails
```
## Authors
👤 **Ahmad Zamir Yousufi** 
- GitHub: [@ahzamir](https://github.com/ahzamir).
- Twitter: [@YousufiZamir](https://twitter.com/YousufiZamir)
- LinkedIn: [ahmad-zamir-yousufi](https://www.linkedin.com/in/ahzamir/)
## 🤝 Contributing
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/ahzamir/blog-app/issues).
## Show your support
Give a ⭐️ if you like this project!
## Acknowledgments
- [Microverse](https://www.microverse.org/)
- Code Reviewers
- Coding Partners
## 📝 License
This project is [MIT](./MIT.md) licensed.
