https://github.com/dansantander/rails_blog
This is a project for creating a blog with RoR
https://github.com/dansantander/rails_blog
Last synced: 7 months ago
JSON representation
This is a project for creating a blog with RoR
- Host: GitHub
- URL: https://github.com/dansantander/rails_blog
- Owner: dansantander
- License: mit
- Created: 2020-05-04T19:10:03.000Z (about 6 years ago)
- Default Branch: development
- Last Pushed: 2023-01-19T18:45:31.000Z (over 3 years ago)
- Last Synced: 2025-02-02T10:12:21.647Z (over 1 year ago)
- Language: Ruby
- Size: 72.3 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# rails_blog
This is a project for creating a blog web app using ruby on rails
## Features
The app has two levels of authorization;
- A client can
- view public documents on the website
- signup for an account to be able to create articles
- create comments on articles
- An author has all the privileges of a regular user but the author can also perform the following actions:
- view all authors
- post(create) articles that can be read by normal clients
- the author can also, update and remove an article
- create, view all tags about each article
## Technologies
The application was developed with [Ruby on Rails](https://rubyonrails.org/), [Sqlite3](http://www.sqlite.org) for database management in development.
## Installation
Follow the steps below to setup a local development environment. First ensure you have [Sqlite3](http://www.sqlite.org) installed, and a version of [Ruby on Rails](https://rubyonrails.org/) equal or greater than v5.2.3 .
1. Clone the repository from a terminal `git clone https://github.com/dansantander/rails_blog`.
2. Navigate to the project directory `rails_blog`
3. Install project dependencies `bundle install`
4. Start the rails server `rails server`
5. Visit localhost:3000 and Voila!!!
### Auth
EndPoint | Functionality
------------------------------|------------------------
POST /authors/new | Allows a client to create an account.
POST /login | signs in a user(author)
### Articles
EndPoint | Functionality
---------------------------------|------------------------
GET /articles | Allows a client to view all articles.
GET /articles/:article_id | Allows a client to view a specific article.
PATCH /articles/:article_id/edit | Allows an author to edit an specific article.
DELETE /articles/:article_id | Allows an author to delete an specific article.
### Comments
EndPoint | Functionality
-----------------------------------|------------------------
POST /articles/:article_id/comment | Allows a client to comment on an article.
### Tags
EndPoint | Functionality
-----------------------------------|------------------------
GET /tags | Allows an client to view all tags.
GET /tags/:tag_id | Allows a author to view a specific tag.
## Authors
👤 **Alfred Ezaka**
- Github: [@codecell](https://github.com/codecell)
- Twitter: [@the_codecell](https://twitter.com/the_codecell)
- Linkedin: [ezaka alfred](https://www.linkedin.com/in/alfrednoble/)
👤 **Daniel Santander**
- Github [Github profile](https://github.com/dansantander)
- Twitter: [@pordios_cero](https://twitter.com/pordios_cero)
- Linkedin: [daniel santander](https://www.linkedin.com/in/daniel-santander/)
## Show your support
Give a ⭐️ if you like this project!