[{"_1":2,"_161":-5,"_162":-5},"loaderData",{"_3":4,"_17":18,"_25":26,"_140":141},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7,"_13":14,"_15":16},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","theme","system","contrast","normal","routes/_layout",{"_19":-5,"_20":21,"_22":21,"_23":11,"_24":21},"username","isAskGordonEnabled",true,"isUsingNewTemplate","showMinimalLanding","showHoneypotTrap","routes/_layout.r.$namespace.$reponame",{"_27":28,"_29":-5,"_30":11,"_31":11,"_32":33,"_34":35,"_36":-5,"_37":11,"_38":39,"_88":-5,"_89":90,"_129":-5,"_130":11,"_131":21,"_132":11,"_133":-5,"_134":11,"_135":-5,"_136":137,"_138":91,"_139":-7},"canonicalUrl","https://hub.docker.com/r/boranseckin/auth-api-jwt/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","boranseckin","reponame","auth-api-jwt","cloudBuildSource","isAutobuildsAvailable","repo",{"_40":41,"_42":43,"_45":46,"_47":48,"_49":11,"_50":51,"_52":53,"_54":55,"_57":35,"_32":33,"_58":59,"_60":44,"_61":62,"_63":64,"_65":66,"_67":-5,"_68":62,"_69":70,"_71":11,"_72":33,"_73":74,"_79":11,"_80":81,"_85":33,"_86":87},"categories",[],"content_types",[44],"image","date_registered","2020-03-24T00:46:14.678114Z","description","RESTful authentication API using JWT","is_private","last_updated","2021-07-03T13:49:15.993915Z","last_modified","2024-10-16T13:48:34.145251Z","media_types",[56],"application/vnd.docker.container.image.v1+json","name","pull_count",364,"repository_type","star_count",0,"status",1,"status_description","active","source","collaborator_count","full_description","# auth-api-jwt\n\n[![Build Status](https://travis-ci.com/boranseckin/auth-api-jwt.svg?branch=master)](https://travis-ci.com/boranseckin/auth-api-jwt) ![Docker Cloud Build Status](https://img.shields.io/docker/cloud/build/boranseckin/auth-api-jwt) [![codecov](https://codecov.io/gh/boranseckin/auth-api-jwt/branch/master/graph/badge.svg)](https://codecov.io/gh/boranseckin/auth-api-jwt)\n\nThis is a REST API written in Typescript using Express. It handles authentication and authorization. It has a security layer provided by JSON Web Token. API uses MongoDB to store the user data. In order to use the server, you have to connect to a database.\n\n## Usage\nClone the repository to your machine.\n\nPull the `mongo` image from the Docker Hub and run it with `-v ~/data:/etc/db` to use a local volume. Configure the authentication as such you will have a username and password for a database to be used by the API.\n\nOnce you successfully configured the MongoDB create a `docker-compose.yml` file using the example below. You have to change ``, ``, `` to match your authentication credentials.\n\nIn order to use JWT, you have to specify a secret string. Change the `` to a secret of your choice.\n\nOnce your compose file is ready, run `docker-compose up`.\n\nExample `docker-compose.yml` file:\n```\nversion: '3'\nservices:\n mongodb:\n image: mongo:latest\n command: [--auth]\n container_name: mongodb\n volumes:\n - ~/data:/data/db\n ports:\n - \"27017:27017\"\n web:\n image: boranseckin/auth-api-jwt\n container_name: app\n depends_on:\n - mongodb\n environment:\n - NODE_ENV=production\n - PORT=3000\n - dbUrl=mongodb\n - dbPort=27017\n - dbName= # TODO: change this\n - dbUsername= # TODO: change this\n - dbPassword= # TODO: change this\n - secret= # TODO: change this\n ports:\n - \"3000:3000\"\n```\n\n## Routes\n\n#### Auth - /api/auth\n- `POST /signup`: Used to signup a new user.\n - Required body:\n `user: {\n username: \"string\",\n email: \"string\",\n password: \"string\"\n }`\n - Returns: Object of user info with JWT token.\n\n- `POST /login`: Used to login as an existing user.\n - Required body:\n `user: {\n username: \"string\" | email: \"string\",\n password: \"string\"\n }`\n - Returns: Object of user info with JWT token.\n \n#### Users - /api/users\n- `GET /`: Used to return the currnet user's information.\n - Required Authorization request header as a Bearer JWT token. `Bearer `\n - Returns:\n - Object of the current user's info if the request is made by a regular user.\n - Object of all users' info if the request is made by an admin user.\n\n- `GET /:username`: Used to return a user's info.\n - Required Authorization request header as a Bearer JWT token. `Bearer `\n - Returns:\n - Object of the current user's info if the request is made by a regular user and the user is itself.\n - Object of the user's info if the request is made by an admin user.\n\n- `DELETE /:username`: Used to delete a user.\n - Required Authorization request header as a Bearer JWT token. `Bearer `\n - Returns: Username of the deleted user if the request is made by an admin user.\n \n## Author\n- Boran Seckin\n\n## License\nThis project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details.\n","has_starred","hub_user","immutable_tags_settings",{"_75":11,"_76":77},"enabled","rules",[78],".*","is_automated","permissions",{"_82":21,"_83":11,"_84":11},"read","write","admin","user","storage_size",2373932514,"orgData","recentTags",[91],{"_92":44,"_93":94,"_95":96,"_97":98,"_99":100,"_50":118,"_119":94,"_120":33,"_121":56,"_57":122,"_123":124,"_125":109,"_126":118,"_127":66,"_128":21},"content_type","creator",6048107,"full_size",155944260,"id",91969044,"images",[101],{"_102":103,"_104":105,"_106":107,"_108":109,"_110":111,"_112":113,"_114":107,"_115":-5,"_116":96,"_63":66,"_117":-5},"architecture","amd64","digest","sha256:eb2eebcdfc6b963dd39b5a226c377fb9efa4e7751019b193ae15f168acd038bb","features","","last_pulled","2026-10-07T05:57:20.818770249Z","last_pushed","2021-07-03T13:49:16Z","os","linux","os_features","os_version","size","variant","2021-07-03T13:49:15.695655Z","last_updater","last_updater_username","media_type","latest","repository",8698056,"tag_last_pulled","tag_last_pushed","tag_status","v2","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","showSbxLogoOverride","sbxTrademarkText","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"selectedTag","attestationsUrl","routes/_layout.r.$namespace.$reponame.tags",{"_38":142,"_149":150,"_136":159,"_160":11},{"_40":143,"_42":144,"_45":46,"_47":48,"_49":11,"_50":51,"_52":53,"_54":145,"_57":35,"_32":33,"_58":59,"_60":44,"_61":62,"_63":64,"_65":66,"_67":-5,"_68":62,"_69":70,"_71":11,"_72":33,"_73":146,"_79":11,"_80":148,"_85":33,"_86":87},[],[44],[56],{"_75":11,"_76":147},[78],{"_82":21,"_83":11,"_84":11},"tags",{"_151":64,"_152":-5,"_153":-5,"_154":155},"count","next","previous","results",[156],{"_92":44,"_93":94,"_95":96,"_97":98,"_99":157,"_50":118,"_119":94,"_120":33,"_121":56,"_57":122,"_123":124,"_125":109,"_126":118,"_127":66,"_128":21},[158],{"_102":103,"_104":105,"_106":107,"_108":109,"_110":111,"_112":113,"_114":107,"_115":-5,"_116":96,"_63":66,"_117":-5},[],"canDeleteTags","actionData","errors"]

boranseckin/auth-api-jwt

Tags for boranseckin/auth-api-jwt