https://github.com/voltageddebunked/inspire_api
InspireAPI is a simple RESTful API that provides random motivational quotes. It can be used in applications to inspire and motivate users.
https://github.com/voltageddebunked/inspire_api
Last synced: over 1 year ago
JSON representation
InspireAPI is a simple RESTful API that provides random motivational quotes. It can be used in applications to inspire and motivate users.
- Host: GitHub
- URL: https://github.com/voltageddebunked/inspire_api
- Owner: VoltagedDebunked
- License: apache-2.0
- Created: 2024-07-20T15:54:41.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-12T17:06:27.000Z (almost 2 years ago)
- Last Synced: 2025-02-03T16:58:14.642Z (over 1 year ago)
- Language: JavaScript
- Size: 20.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# InspireAPI
InspireAPI is a simple RESTful API that provides random motivational quotes. It can be used in applications to inspire and motivate users.
## Getting Started
### Prerequisites
- Node.js
- npm (Node Package Manager)
### Installation
1. Clone the repository:
```bash
git clone https://github.com/voltageddebunked/inspire_api.git
```
2. Navigate to the project directory:
```bash
cd inspire_api
```
3. Install the dependencies:
```bash
npm install
```
### Running the Application
Start the Express server:
```bash
node index.js
```
The server will start and listen on port 3000.
### Usage
You can access the API endpoint to get a random motivational quote.
**Endpoint:**
```bash
GET /quote
```
**Example Request:**
```bash
curl http://localhost:3000/quote
```
**Example Response:**
```json
{
"quote": "The best way to predict the future is to invent it. – Alan Kay"
}
```
### Expanding and Improving
1. **Expand the Quotes List**: Add more quotes to the list in `index.js`.
2. **Categorize Quotes**: Introduce categories for different types of motivation.
3. **Add Filtering Options**: Allow users to request quotes by category or author.
4. **User Contributions**: Allow users to submit their own quotes to be included in the API.
### Deployment
Deploy your API to a cloud provider such as AWS, Google Cloud, or Heroku to make it accessible over the internet.
- **Heroku**: Follow [Heroku's guide](https://devcenter.heroku.com/articles/getting-started-with-nodejs) for deploying a Node.js app.
- **AWS**: Use services like AWS Elastic Beanstalk or AWS Lambda for deployment.
### License
This project is licensed under the Apache 2.0 License. See the [LICENSE](LICENSE) file for details.