https://github.com/yuvenalmash/inkwell-blog-api
Inkwell Blog Api is a RESTful API that can be used as a backend for an blog application. It allows users to perform all CRUD operations. Requests are authenticated with JWT tokens.
https://github.com/yuvenalmash/inkwell-blog-api
jwt-authorization rspec-testing ruby-on-rails
Last synced: about 2 months ago
JSON representation
Inkwell Blog Api is a RESTful API that can be used as a backend for an blog application. It allows users to perform all CRUD operations. Requests are authenticated with JWT tokens.
- Host: GitHub
- URL: https://github.com/yuvenalmash/inkwell-blog-api
- Owner: yuvenalmash
- License: mit
- Created: 2023-05-07T13:17:34.000Z (about 3 years ago)
- Default Branch: dev
- Last Pushed: 2023-06-18T22:55:41.000Z (almost 3 years ago)
- Last Synced: 2025-06-29T12:43:18.495Z (12 months ago)
- Topics: jwt-authorization, rspec-testing, ruby-on-rails
- Language: Ruby
- Homepage:
- Size: 142 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Inkwell Blog API
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [📝 License](#license)
**Inkwell Blog API** is a RESTful API for a blog application. It is built with Ruby on rails and PostgreSQL.
Framework
Database
- **User Authentication**
- Users can sign up and sign in.
- Users can sign out.
- Users can reset their password.
- **Requests Authentication**
- All requests are secured with a JWT generated when a user logs in.
- The JWT expires after the specified duration
- **Blog posts**
- Users perfom CRUD operations on posts
- Users can comment and like posts
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need:
- Ruby
- Rails
- PostgreSql
### Setup
Clone this repository to your desired folder:
```sh
cd my-folder
git clone git@github.com:yuvenalmash/inkwell-blog-api.git
```
#### Prepare Data Base
```
rails db create
rails db migrate
```
### Install
Install this project with:
```sh
cd inkwell-blog-api
bundle install
```
### Usage
To run the project, execute the following command:
```sh
rails server
```
### Run tests
To run tests, run the following command:
```sh
rspec
```
👤 **Yuvenal Njoroge**
- GitHub: [@yuvenalmash](https://github.com/yuvenalmash)
- Twitter: [@YuvenalNjoroge](https://twitter.com/YuvenalNjoroge)
- LinkedIn: [Yuvenal Njoroge](https://linkedin.com/in/yuvenal-njoroge)
- [ ] **Deploy project**
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/yuvenalmash/inkwell-blog-api/issues).
If you like this project give it a star
This project is [MIT](./LICENSE) licensed.