• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 📝 License

Inkwell Blog API is a RESTful API for a blog application. It is built with Ruby on rails and PostgreSQL.

• 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

(back to top)

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

In order to run this project you need:

• Ruby
• Rails
• PostgreSql

Clone this repository to your desired folder:

  cd my-folder
  git clone [email protected]:yuvenalmash/inkwell-blog-api.git

rails db create
rails db migrate

Install this project with:

  cd inkwell-blog-api
  bundle install

To run the project, execute the following command:

  rails server

To run tests, run the following command:

  rspec

👤 Yuvenal Njoroge

• GitHub: @yuvenalmash
• Twitter: @YuvenalNjoroge
• LinkedIn: Yuvenal Njoroge

(back to top)

• Deploy project

(back to top)

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

If you like this project give it a star

(back to top)

This project is MIT licensed.

(back to top)