README.md

README Template

📗 Table of Contents

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

📖 Idea App

A platform for generating and sharing ideas. Users can create and destroy their own ideas, as well as upload pictures to support their concepts with CarrierWave gem. The app also includes a feature for users to upload a profile picture with Gravtastic gem. Users can browse and comment on ideas shared by others, providing feedback and discussions.

🛠 Built With

Tech Stack

Client

• Embedded Ruby

Server

• Rails

Database

• PostgreSQL

Key Features

• [User Authentication]
• [Add/Remove Ideas]
• [Add/Remove Comments]
• [Upload/Remove Profile Picture]
• [Upload/Remove Idea Picture]

(back to top)

🚀 Live Demo

• Live Demo Link

(back to top)

💻 Getting Started

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

Prerequisites

In order to run this project you need:

 gem install rails

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone [email protected]:myaccount/my-project.git

Install

Install this project with:

  cd my-project
  gem install

Usage

To run the project, execute the following command:

  rails server

Run tests

To run tests, run the following command:

  bin/rails test test/models/

Deployment

You can deploy this project using:

(back to top)

👥 Author

👤 OmarMWarraich

• GitHub: @OmarMWarraich
• Twitter: @omarwarraich1
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

Describe 1 - 3 features you will add to the project.

• [Pagination]
• [Search]
• [Email Notifications]
• [Social Media Integration]
• [WebRTC]

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project please give it a ⭐️!.

(back to top)

🙏 Acknowledgments

I would like to thank the following.

• Rails Guides for providing a great resource for learning Rails.

(back to top)

❓ FAQ

• [Is this app free to use?]

  • [Please check the license.]

• [How to use this app?]

  • [Please check the usage section.]

(back to top)

📝 License

This project is MIT licensed.

(back to top)