ahampriyanshu / norm-has-an-api

Any history buff here?

RIP Norm ❤️

Base URL

• https://normhasanapi.herokuapp.com

API Endpoints

Get by name

• https://normhasanapi.herokuapp.com/name/{String}

$ curl https://normhasanapi.herokuapp.com/name/louieck

Get by id

• https://normhasanapi.herokuapp.com/id/{Integer}

$ curl https://normhasanapi.herokuapp.com/id/1

Get n comics at random

• https://normhasanapi.herokuapp.com/list/{Integer}

$ curl https://normhasanapi.herokuapp.com/list/3

Get by born year

• https://normhasanapi.herokuapp.com/born/{after/before}/{Integer}

$ curl https://normhasanapi.herokuapp.com/born/after/1970

Get by working year

• https://normhasanapi.herokuapp.com/since/{Integer}

$ curl https://normhasanapi.herokuapp.com/since/1990

Get by age

• https://normhasanapi.herokuapp.com/age/{min/max}/{Integer}

$ curl https://normhasanapi.herokuapp.com/age/min/50

Get by vital status

• https://normhasanapi.herokuapp.com/alive/{Boolean}

$ curl https://normhasanapi.herokuapp.com/alive/true

Get by nationality

• https://normhasanapi.herokuapp.com/nationality/{String}

$ curl https://normhasanapi.herokuapp.com/nationality/indian

Get by ethnicity

• https://normhasanapi.herokuapp.com/ethnicity/{String}

$ curl https://normhasanapi.herokuapp.com/ethnicity/irish

Hacktoberfest 2022

How To Contribute

1. Fork the repo

2. Clone the forked repo on your local machine

git clone [e-mail]:{GITHUB_USERNAME}/norm-has-an-api.git -b main --single-branch

• Adding a new SSH key to your GitHub account

3. Switch to new branch

git checkout -b '{COMIC_NAME}'

4. Add/modify the required file

• Before proceeding forward read the contributing guidelines

Fixing any empty/invalid data: Commit directly to db/db.json Adding a new comic: Create a new file in the raw folder. For reference, take a look at 000.json.

• File Naming Convention

5. Move the active changes to the staging area.

git add .

6. Commit the changes in local

git commit -m 'some relevant message'

• Commit Naming Convention

7. Push the changes to the remote

git push -u origin {BRANCH_NAME}

8. Compare And Pull

• Before pulling make sure your branch is up-to-date

9. Create a new pull request by giving a relevant PR message

10. Congrats 🎉

11. Wait till PR is merged

Sync Your Forked Repository

CLI

$ git fetch --all
$ git checkout main
$ git reset --hard upstream/main
$ git push origin main

GUI

Attribution

Built with Express and deployed on Heroku

Contributing Guidelines

Read contributing guidelines

License

This project is licensed under the MIT License.