Skip to content
/ sporf Public

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

Notifications You must be signed in to change notification settings

paulzay/sporf

Repository files navigation

Sporf

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

Coverage Status Build Status 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

Screenshots

Screenshot from 2020-09-20 11-34-29 Screenshot from 2020-09-20 11-34-56 Screenshot from 2020-09-20 11-35-18

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:

# 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

Attribution

🤝 Contributing

Contributions, issues and feature requests are welcome!

Feel free to check the issues page.

Show your support

Give a ⭐️ if you like this project!

About

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

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published