{"id":15152557,"url":"https://github.com/ricardoliveira5ro/pathwayapi-graphql","last_synced_at":"2026-01-22T18:03:52.833Z","repository":{"id":250502381,"uuid":"834643357","full_name":"ricardoliveira5ro/PathwayAPI-GraphQL","owner":"ricardoliveira5ro","description":"GraphQL API designed  to create, manage and track personalized roadmaps breaking them down into manageable steps","archived":false,"fork":false,"pushed_at":"2024-08-13T11:35:05.000Z","size":96,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-08T14:13:49.897Z","etag":null,"topics":["graphql-api","postgresql","ruby","ruby-on-rails"],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ricardoliveira5ro.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-07-27T22:50:50.000Z","updated_at":"2024-08-13T11:35:08.000Z","dependencies_parsed_at":"2024-08-11T23:18:59.450Z","dependency_job_id":"eb6522d4-9730-42a4-a0af-f0549acca190","html_url":"https://github.com/ricardoliveira5ro/PathwayAPI-GraphQL","commit_stats":null,"previous_names":["ricardoliveira5ro/pathwayapi-graphql"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ricardoliveira5ro%2FPathwayAPI-GraphQL","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ricardoliveira5ro%2FPathwayAPI-GraphQL/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ricardoliveira5ro%2FPathwayAPI-GraphQL/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ricardoliveira5ro%2FPathwayAPI-GraphQL/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ricardoliveira5ro","download_url":"https://codeload.github.com/ricardoliveira5ro/PathwayAPI-GraphQL/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247856543,"owners_count":21007621,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["graphql-api","postgresql","ruby","ruby-on-rails"],"created_at":"2024-09-26T16:03:41.806Z","updated_at":"2026-01-22T18:03:52.790Z","avatar_url":"https://github.com/ricardoliveira5ro.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# PathwayAPI (GraphQL)\n\n`pathwayapi-graphql.onrender.com` hosts a public instance of the API. \n\n\u003e [!Important]\n\u003e Please notice this API serves the same purpose of the original one, but with a different architecture. You can find everything you need to know in this [repository](https://github.com/ricardoliveira5ro/PathwayAPI/blob/master/README.md)\n\u003cbr/\u003e\n\n## 🚀 Getting Started\n\n#### 🔐 Authentication / Authorization\n\nEach endpoint requires prior authentication based on bearer token. This token can be obtained after signing up and/or logging and it will be needed as authorization header in every request you make.\n\n**Register**\n```\nmutation Register {\n    register(email: \"test@example.com\", password: \"1234567890\") {\n        user {\n            id\n            email\n            createdAt\n        }\n        success\n        errors {\n            fullMessages\n        }\n    }\n}\n```\n\n**Login**\n```\nmutation Login {\n    login(email: \"test@example.com\", password: \"1234567890\") {\n        errors\n        success\n        token\n    }\n}\n```\n\n---\n\n#### 🔍 Query\nUse queries to obtain one object or a list of objects, like Roadmaps, Categories and Steps\n\n```\nquery Roadmaps {\n    roadmaps {\n        id\n        description\n        title\n        completed\n        categories {\n            id\n            name\n        }\n        steps {\n            id\n            completed\n            description\n            order\n            roadmapId\n            title\n        }\n    }\n}\n```\n\n---\n\n#### 🧬 Mutations\nUse mutations to create or modify an object, like Roadmaps, Steps and Tracking Steps\n\n```\nmutation CreateRoadmap {\n    createRoadmap(\n        title: \"New Roadmap\"\n        description: \"New Roadmap Description\"\n        categoryIds: [7, 8]\n        steps: [\n            { title: \"First Step\", description: \"First Description Step\", order: 1 },\n            { title: \"Second Step\", description: \"Second Description Step\", order: 2 }\n        ]\n    ) {\n        success\n        errors {\n            details\n            fullMessages\n        }\n        roadmap {\n            id\n            title\n            description\n            categories {\n                id\n                name\n            }\n            steps {\n                id\n                title\n                description\n                order\n            }\n        }\n    }\n}\n```\n\n\u003cbr/\u003e\n\n## 💻 Technical Details\n\nThis section is for the developers who want to explore the technical characteristics of the API.\n\n#### 🛠️ Tech stack\n\n* Ruby (v3)\n* Ruby on rails (v7)\n* Postgresql\n* graphql (gem)\n* jwt (gem)\n\n#### 🚀 Run\n\n* Run `bundle install`\n* Create the user/role in your local postgres database\n* Edit your *database.yml* to include your local database information provided by your keys in *credentials.yml.enc*\n* Run `rails db:create` and `rails db:migrate` (every time there is a change in your schema)\n* Edit your *seeds.rb* file to include any preloaded data and run `run db:seed`\n* Start the server `rails s`\n\n#### 💭 Considerations\n\n* Postgre database hosted in *neon.tech*\n* Webservice hosted in *render.com*\n* Use of *Postman* or any other graphql interpreter recommended to check all the queries and mutations available","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fricardoliveira5ro%2Fpathwayapi-graphql","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fricardoliveira5ro%2Fpathwayapi-graphql","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fricardoliveira5ro%2Fpathwayapi-graphql/lists"}