https://github.com/eccb7/the-readers

https://github.com/eccb7/the-readers

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/eccb7/the-readers
• Owner: Eccb7
• License: mit
• Created: 2024-02-25T20:41:14.000Z (9 months ago)
• Default Branch: dev
• Last Pushed: 2024-03-07T19:49:00.000Z (9 months ago)
• Last Synced: 2024-03-07T20:45:05.286Z (9 months ago)
• Language: Ruby
• Size: 51.8 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
---

marp: true

---







> # The Readers

# 📗 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)

- [🙏 Acknowledgements](#acknowledgements)

- [❓ FAQ (OPTIONAL)](#faq)

- [📝 License](#license)

# 📖 Fast Recipes 

"**The readers** app is a web application built using Ruby on Rails, allowing users to manage and explore a collection of books, including features for adding, editing, and deleting book entries with an optional user authentication system."

## 🛠 Built With 

### Tech Stack 

- Client

    


      
Ruby on Rails

      
PostgreSQL

    


### Key Features 

1. **Book Management:**

   - Users can efficiently manage their book collection, including adding new books with details like title, author, and description, as well as updating and deleting existing entries.

2. **User Authentication:**

   - For personalized experiences, the app supports user authentication, allowing individuals to create accounts, log in, and access features like saving and maintaining their own curated booklists.

3. **Responsive Design with Styling:**

   - The app incorporates responsive design principles and styling, providing an aesthetically pleasing and user-friendly interface, potentially leveraging CSS frameworks for improved visual presentation.

## 💻 Getting Started 

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

### Prerequisites

In order to run this project you need:

- A browser of you choice.

- A text editor of your choice.

- An installed ruby gem on your local system

- Rails needs to be installed on your system

### Setup

Clone this repository to your desired folder:

- Use the following Commands:

### Install

### Usage

- bin/rails server (to run web application)

### Run tests

(back to top)


## 👥 Author 

👤 **Ojwang Briton**

- GitHub: [@Eccb7](https://github.com/Eccb7)

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

- LinkedIn: [briton-otieno](https://linkedin.com/in/briton-otieno)

(back to top)


## 🔭 Future Features 

(back to top)


## 🤝 Contributing 

Contributions, issues, and feature requests are welcome!

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

(back to top)


## ⭐️ Show your support 

If you like this project you can reach me through [@briton_otieno4](https://twitter.com/briton_otieno4) and share more thoughts to help improve

If you like this project, give it a ⭐️.

(back to top)


## 🙏 Acknowledgments 

I would like to thank The University Of Helsinki for the support I've received so far.

(back to top)


## 📝 License 

This project is [MIT](./LICENSE) licensed.