{"id":25171281,"url":"https://github.com/basemax/travelapits","last_synced_at":"2025-08-19T08:07:03.021Z","repository":{"id":173583257,"uuid":"650014764","full_name":"BaseMax/TravelAPITS","owner":"BaseMax","description":"This is a RESTful API for managing travel-related information, including cities, tourist places, and user authentication. It is built with NestJS and TypeScript.","archived":false,"fork":false,"pushed_at":"2025-04-11T19:31:46.000Z","size":659,"stargazers_count":7,"open_issues_count":1,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-08-19T06:01:55.734Z","etag":null,"topics":["api","api-restful","api-ts","api-typescript","javascript","js","nestjs","nestjs-api","restful","restful-api","ts","ts-api","typescript","typescript-api"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/BaseMax.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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,"zenodo":null}},"created_at":"2023-06-06T06:37:08.000Z","updated_at":"2025-04-11T19:31:45.000Z","dependencies_parsed_at":"2023-12-08T13:29:05.010Z","dependency_job_id":"7b00c78d-9ffb-4408-9b4a-fe8e87cdb344","html_url":"https://github.com/BaseMax/TravelAPITS","commit_stats":null,"previous_names":["basemax/travelapits"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/BaseMax/TravelAPITS","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BaseMax%2FTravelAPITS","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BaseMax%2FTravelAPITS/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BaseMax%2FTravelAPITS/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BaseMax%2FTravelAPITS/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/BaseMax","download_url":"https://codeload.github.com/BaseMax/TravelAPITS/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BaseMax%2FTravelAPITS/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":271121168,"owners_count":24702723,"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","status":"online","status_checked_at":"2025-08-19T02:00:09.176Z","response_time":63,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["api","api-restful","api-ts","api-typescript","javascript","js","nestjs","nestjs-api","restful","restful-api","ts","ts-api","typescript","typescript-api"],"created_at":"2025-02-09T09:19:45.691Z","updated_at":"2025-08-19T08:07:02.990Z","avatar_url":"https://github.com/BaseMax.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Travel API TS\n\nThis is a RESTful API for managing travel-related information, including cities, tourist places, and user authentication. It is built with NestJS and TypeScript.\n\n## Features\n\n- Create a city\n- Get a list of all cities\n- Search for cities\n- Delete a city\n- Edit a city\n- Add tourist places for a city\n- Delete a tourist place\n- Edit a tourist place\n- User registration\n- User login\n- Authenticated routes\n\n## Prerequisites\n\n- Node.js (version X.X.X)\n- npm (version X.X.X)\n- PostgreSQL (version X.X.X)\n\n## Installation\n\nClone the repository:\n\n```shell\ngit clone https://github.com/BaseMax/TravelAPITS.git\n```\n\nInstall the dependencies:\n\n```shell\ncd TravelAPITS\nnpm install\n```\n\nConfigure the database:\n\n- Create a PostgreSQL database.\n- Update the database configuration in `src/config/database.ts`.\n\nRun database migrations:\n\n```shell\nnpm run migration:run\n```\n\nStart the server:\n\n```shell\nnpm run start:dev\n```\n\nThe API server will start running at http://localhost:3000.\n\n## API Endpoints\n\n### Cities\n\n- `POST /cities` - Create a city\n- `GET /cities` - Get a list of all cities\n- `GET /cities/search?q={query}` - Search for cities (replace {query} with the search term)\n- `GET /cities/{id}` - Get details of a specific city\n- `PUT /cities/{id}` - Update a specific city\n- `DELETE /cities/{id}` - Delete a specific city\n\n### Tourist Places\n\n- `POST /cities/{cityId}/tourist-places` - Add a tourist place for a city\n- `GET /cities/{cityId}/tourist-places` - Get tourist places for a city\n- `GET /cities/{cityId}/tourist-places/{id}` - Get details of a specific tourist place\n- `PUT /cities/{cityId}/tourist-places/{id}` - Update a specific tourist place\n- `DELETE /cities/{cityId}/tourist-places/{id}` - Delete a specific tourist place\n\n### Authentication\n\n- `POST /auth/register` - User registration\n- `POST /auth/login` - User login\n- `GET /auth/check` - Check authentication status\n\n## Environment Variables\n\nMake sure to set the following environment variables:\n\n- `PORT` - The port on which the server will run (default: 3000)\n- `DATABASE_HOST` - PostgreSQL database host\n- `DATABASE_PORT` - PostgreSQL database port\n- `DATABASE_USERNAME` - PostgreSQL database username\n- `DATABASE_PASSWORD` - PostgreSQL database password\n- `DATABASE_NAME` - PostgreSQL database name\n- `JWT_SECRET` - Secret key for JSON Web Token generation\n\n## Contributing\n\nContributions are welcome! Please feel free to open issues or submit pull requests.\n\n## License\n\nThis project is licensed under the GPL-3.0 License.\n\nCopyright 2023, Max Base\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbasemax%2Ftravelapits","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbasemax%2Ftravelapits","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbasemax%2Ftravelapits/lists"}