https://github.com/kdlamini/mindly
The Mindly app is a classic example of a blog website. This will is a fully functional website that will show the list of posts and empower readers to interact with them by adding comments and liking posts.
https://github.com/kdlamini/mindly
rails ruby
Last synced: 2 months ago
JSON representation
The Mindly app is a classic example of a blog website. This will is a fully functional website that will show the list of posts and empower readers to interact with them by adding comments and liking posts.
- Host: GitHub
- URL: https://github.com/kdlamini/mindly
- Owner: KDlamini
- Created: 2022-02-17T14:55:32.000Z (over 4 years ago)
- Default Branch: dev
- Last Pushed: 2022-04-21T13:58:22.000Z (about 4 years ago)
- Last Synced: 2025-03-30T15:47:24.125Z (over 1 year ago)
- Topics: rails, ruby
- Language: Ruby
- Homepage: https://mindly-blogs.herokuapp.com/
- Size: 225 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Mindly Blog App
The Mindly app will be a classic example of a blog website. This will be a fully functional website that will show the list of posts and empower readers to interact with them by adding comments and liking posts.
## Built With
- Ruby on Rails
## Live Preview
[Demo](https://mindly-blogs.herokuapp.com/)
## Additional Tools
- rubocop
- stylelint
- Ruby Gems
## Versions
- Ruby ~3.1.0
- PostgreSQL ~12.9
- Node.js ~14.17.6
- Yarn ~1.22.17
## `Getting Started`
To get a local copy of this project:
Clone this repository or download the Zip folder:
```
$ git clone git@github.com:KDlamini/mindly.git
```
Then:
```
$ cd mindly
$ gem install bundler
$ bundle install
```
To start App:
```
$ rails server
```
To view on browser:
```
http://localhost:3000
```
## `Database creation`
Create a Postgres user:
```
$ su - postgres
```
After that access Postgres:
```
psql
```
Then create a user (or a βroleβ, as Postgres calls it):
```
CREATE ROLE mindly WITH CREATEDB LOGIN PASSWORD 'mindly';
```
Initialize the database:
```
$ bin/rails db:setup
```
Migrate the database:
```
$ bin/rails db:create
```
## `Tests`
### Running specs:
Default: Run all spec files (i.e., those matching spec/**/*_spec.rb):
```
$ bundle exec rspec
```
Run all spec files in a single directory (recursively):
```
$ bundle exec rspec spec/models
```
Run a single spec file:
```
$ bundle exec rspec spec/controllers/accounts_controller_spec.rb
```
Run a single example from a spec file (by line number):
```
$ bundle exec rspec spec/controllers/accounts_controller_spec.rb:8
```
See all options for running specs:
```
$ bundle exec rspec --help
```
### rails tests:
```
$ bin/rails test
```
### To track linter errors locally follow these steps:
Track Ruby linter errors run:
```
$ rubocop
```
To auto-correct correctable Rubocop offenses run:
```
$ rubocop --auto-correct-all | rubocop -A
```
## `Authors`
π€ **Simo Nkosi**
- GitHub: [@KDlamini](https://github.com/KDlamini)
- Twitter: [@RealSimoNkosi](https://twitter.com/RealSimoNkosi)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/simo-nkosi-418523180/)
## π€ Contributing
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/KDlamini/mindly/issues).
## Show your support
Give a βοΈ if you like this project!
## Acknowledgments
- This project is part module 5 in the Microverse study program.
- Thanks to the Microverse team for the great curriculum.
- Thanks to Code Reviewers for the insightful feedback.
- A great thanks to My coding partners, morning session team, and standup team Partners for their contributions.
## π License
This project is [MIT](./MIT.md) licensed.