https://github.com/paulzay/sporf

Sporf is a blogging platform where bloggers can signup and write articles that are grouped by categories. It's built with Ruby on Rails
https://github.com/paulzay/sporf

article rails rspec ruby

Last synced: 2 months ago
JSON representation

Sporf is a blogging platform where bloggers can signup and write articles that are grouped by categories. It's built with Ruby on Rails

• Host: GitHub
• URL: https://github.com/paulzay/sporf
• Owner: paulzay
• Created: 2020-09-15T11:01:31.000Z (almost 6 years ago)
• Default Branch: develop
• Last Pushed: 2021-01-28T16:38:00.000Z (over 5 years ago)
• Last Synced: 2025-06-08T19:04:13.503Z (about 1 year ago)
• Topics: article, rails, rspec, ruby
• Language: Ruby
• Homepage: https://sporf.herokuapp.com/
• Size: 210 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Sporf

> This is a website for writing sports-related articles based on the different categories given.

[![Coverage Status](https://coveralls.io/repos/github/paulzay/sporf/badge.svg?branch=develop)](https://coveralls.io/github/paulzay/sporf?branch=develop)

![Build Status](https://travis-ci.com/paulzay/sporf.svg?branch=develop)

[![Maintainability](https://api.codeclimate.com/v1/badges/f5d79d29c50d40454612/maintainability)](https://codeclimate.com/github/paulzay/sporf/maintainability)

## Project Features

- The index page contains the most popular article based on votes by the users. Additionally it displays the most recent article in each category. 

- A user can create an account and begin writing their own articles and vote on their own article or others'. 

- A user needs to be logged in to vote on articles

- 

## Built With

- Ruby v2.7.1

- Ruby on Rails v5.2.4

## Live Demo

[Link](https://sporf.herokuapp.com/)

## Screenshots

![Screenshot from 2020-09-20 11-34-29](https://user-images.githubusercontent.com/29974825/93708626-7fdead80-fb40-11ea-85aa-c9d5e7800050.png)

![Screenshot from 2020-09-20 11-34-56](https://user-images.githubusercontent.com/29974825/93708628-82410780-fb40-11ea-8993-aa3310269f53.png)

![Screenshot from 2020-09-20 11-35-18](https://user-images.githubusercontent.com/29974825/93708629-83723480-fb40-11ea-92f7-67b98f7425a4.png)

## Getting Started

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

### Prerequisites

Ruby: 2.6.3

Rails: 5.2.3

Postgres: >=9.5

# Getting Started 🚀

These instructions will get you a copy of the project up and running on your local machine.

## How To Use 🔧

From your command line, first clone the project:

```bash

# Clone this repository

$ git clone https://github.com/paulzay/sporf

# Go into the project folder

$ cd sporf

# run bundle install to get the gems

$ bundle install

# Create the database

$ rails db:create

# Run the migrations

$ rails db:migrate

# Seed user and category data

$ rails db:seed

# To start the rails server, run

$ rails s

# To run the tests, run

$ bundle exec rspec

```

You can create your own data from here

## Author

👤 **Paul Ogolla**

- Github: [@paulzay](https://github.com/paulzay)

- Twitter: [@_paulzay_](https://twitter.com/_paulzay_)

- Linkedin: [Paul Ogolla](https://linkedin.com/in/paulogolla)

# Attribution

- The template was made by Nelson Sakwa

- Check it out here

## 🤝 Contributing

Contributions, issues and feature requests are welcome!

Feel free to check the [issues page](issues/).

## Show your support

Give a ⭐️ if you like this project!