README.md

Inspirational Quotes API

An open source API full of quotes to bring some joy to your day! Please fork, clone, contribute OR use the API for your own project! View the app I created using this API here!
Explore the docs »

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. Acknowledgements

About The Project

Built With

Backend

• Node.js
• Server hosted on Heroku

Frontend

App created with this open source API: You Go, Girl

• React
• Next.js
• SASS
• App hosted on Vercel

Getting Started

To run the project:

1. Clone the repo

   git clone https://github.com/bmumz/inspirational-quotes-api

2. Install NPM packages

   npm install

3. Run npm start

   npm start

Contributing

If you like this project, and inspirational quotes, please consider contributing even just a few of your favorite quotes! BEFORE YOU START make sure you've forked the current repo, since people are committing regularly!

1. Fork the Project
2. Clone.
3. Create your Feature Branch (git checkout -b feature/AmazingFeature)
4. Commit your Changes (git commit -m 'Add some AmazingFeature') please follow the outline

 {
      "id": 0,
      "quote": "Never make someone a priority when all you are to them is an option.",
      "source": "Maya Angelou",
      "link": ""
    },

If the author has a website or social media, please include a link!

5. Push to the Branch (git push origin feature/AmazingFeature)
6. Open a Pull Request

License

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

Contact

Your Name - Portfolio - LinkedIn @brandiCodes on Twitter - brandimummery@gmail.com

Project Link: https://github.com/bmumz/inspirational-quotes-api

Acknowledgements

• You Go, Girl! - the app I created with this API!
• Best-README-Template