Overview:

Feeder FishPS is a learning app designed to collect issues, ideas, and compliments using a simple widget. Users can receive these submissions via email and explore them further using the dashboard.

Features:

• Issue Collection: Users can collect issues, ideas, and compliments using a simple widget.
• Email Notifications: Submissions are sent to users via email for easy access and communication.
• Dashboard: The app provides a dashboard for users to dive deep into the collected submissions and analyze them further.

Installation:

To install the Feeder FishPS app, follow these steps:

1. Clone the repository:

   git clone [repository_url]
   

2. Change into the cloned repository folder:

   cd [repository_folder]
   

3. Install the necessary dependencies:

   bundle install
   

4. Change into the client folder:

   cd client
   

5. Install the client-side dependencies:

   yarn install
   

6. Change back to the root directory of the app:

   cd ..
   

7. Set up the app’s credentials by running either of the following commands based on your editor:

   • For Visual Studio Code:

     EDITOR='code --wait' bin/rails credentials:edit
     

   • For other editors:

     rails credentials:edit
     

8. Enable 2FA authentication in your Gmail account and generate an app password. Refer to this article for instructions on obtaining the app password.

9. Start the app using Foreman and the development Procfile:

   foreman start -f Procfile.dev
   

Alternatively, you can run the backend and the client side independently:

• Backend: Run the following command in the root directory:

  rails s -p 3000
  

• Client: Change into the client folder and start the client separately using:

  cd client && yarn start
  

Summary:

Feeder FishPS is a learning app that allows users to collect feedback and suggestions using a simple widget. With email notifications and a dashboard, users can effectively manage and analyze the collected data. The installation process involves cloning the repository, setting up credentials, and starting the app using Foreman or running the backend and client side independently.