Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve ReadMe and Contributing file by using more descriptions for s… #247

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Improve ReadMe and Contributing file by using more descriptions for s… #247

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,21 @@ $ npm run test
$ npm run lint
```

### Guidelines

Code Style:
Follow the existing code style in the project.
Documentation:
Update the documentation if your changes require it.
Issues:
Before creating a new issue, check if it’s already reported.
Getting Help:
If you have questions or need help, feel free to open an issue or reach out to the maintainers.

Thank you for your contributions!

This structured approach will not only enhance the readability of the README but also make it more useful for new developers. If you have any questions or need further assistance, feel free to ask!

[mongodb/atlas]: https://www.mongodb.com/cloud/atlas
[fork-a-repo]: https://help.github.com/en/articles/fork-a-repo
[cloning-a-repo]: https://help.github.com/en/articles/cloning-a-repository
Expand Down
28 changes: 28 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,27 @@ Quotable is a free, open source quotations API. It was originally built as part

There is a rate limit of **180 requests per minute**, per IP address. If you exceed the rate limit, the API will respond with a `429` error.

### Error Handling

- In your application, make sure to handle errors.
- 429 error indicates that you’ve exceeded the rate limit. You can implement a retry mechanism or notify users when this happens.

### Setup Intructions
1. Clone the repository to your local machine using your terminal:

git clone https://github.com/lukePeavey/quotable.git

cd quotable

These commands will allow you to open the repository on local machine.

2. Open repository in an IDE such as, VSCode.
3. You may need to install dependencies to start the repository:

npm install
npm run database:seed data/sample
npm run start:dev

### API Servers
```
https://api.quotable.io
Expand All @@ -19,6 +40,13 @@ You can try out the API on our public Postman workspace.

[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/quotable/workspace/quotable)

### Steps to explore with Postman

1. Explore with Postman
2. Open Postman and create a new request.
3. Set the request type (GET, POST, etc.) depending on the endpoint you want to use.
4. Enter the endpoint URL (e.g., https://api.quotable.io/random).
5. Click "Send" to make the request and view the response.

## API Reference <!-- omit in toc -->

Expand Down