Sorry

A web application that allows users to listen to anonymously recorded apologies from around the world.


View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

(back to top)

Built With

• React.js
• Express
• Firebase
• Twilio API

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• npm

  npm install npm@latest -g

Installation

1. Get a free API Key at twilio.com
2. Clone the repo

   git clone https://github.com/catmcclelland/another-apology-line.git

3. Install NPM packages

   npm install

4. Enter your API in a .env file in the root of /frontend

   REACT_APP_TWILIO_ACCOUNT=YOUR TWILIO SID
   REACT_APP_TWILIO_AUTH=YOUR TWILIO AUTH

(back to top)

Usage

Users can place a call to (502) 467-6779 to leave a voicemail if they wish. Login available for use of future features. To start listening to the voicemails, just press play.

(back to top)

Roadmap

• Create API for user interaction
• Implement upvote feature
• Implement comments feature

See the open issues for a full list of proposed features (and known issues).

(back to top)

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Project Link: https://github.com/catmcclelland/another-apology-line

(back to top)

(back to top)