{"id":25455381,"url":"https://github.com/yangbeibei88/tafe-weather-rest-api","last_synced_at":"2026-04-12T17:02:38.072Z","repository":{"id":277964625,"uuid":"882804683","full_name":"yangbeibei88/tafe-weather-rest-api","owner":"yangbeibei88","description":"Weather RESTful API for CRUD weather data. The api is built with Deno and MongoDB","archived":false,"fork":false,"pushed_at":"2025-02-17T08:16:24.000Z","size":3085,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-17T09:25:58.599Z","etag":null,"topics":["deno","docker","express","mongodb","rest-api","swagger-ui"],"latest_commit_sha":null,"homepage":"https://tafeweatherapi.beibeiyang.dev/api-docs","language":"TypeScript","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/yangbeibei88.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-11-03T19:57:36.000Z","updated_at":"2025-02-17T08:16:27.000Z","dependencies_parsed_at":"2025-02-17T09:26:02.396Z","dependency_job_id":"e7f56833-1884-4708-a197-f009cb9e08be","html_url":"https://github.com/yangbeibei88/tafe-weather-rest-api","commit_stats":null,"previous_names":["yangbeibei88/tafe-weather-rest-api"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yangbeibei88%2Ftafe-weather-rest-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yangbeibei88%2Ftafe-weather-rest-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yangbeibei88%2Ftafe-weather-rest-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yangbeibei88%2Ftafe-weather-rest-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/yangbeibei88","download_url":"https://codeload.github.com/yangbeibei88/tafe-weather-rest-api/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254567195,"owners_count":22092722,"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":["deno","docker","express","mongodb","rest-api","swagger-ui"],"created_at":"2025-02-18T00:57:23.066Z","updated_at":"2026-04-12T17:02:37.974Z","avatar_url":"https://github.com/yangbeibei88.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# TAFE Weather REST API with MongoDB\n\nThis weather REST API is written in TypeScript, built with Deno (2.1.0), Express, MongoDB NodeJS driver (v6.10.0).\n\n## MongoDB database\n\n- Integrated with MongoDB with official library MongoDB NodeJS driver\n- Persistant json validator to each collection (json validator is database level schema (similar to sql database's table schema), not application level schema like Mongoose)\n- Compound indexes setup to increase query and aggregation performance\n- MongoDB Atlas trigger setup\n\n## Authentication \u0026 Authorisation\n\n- JWT token for user authentication\n- Express middleware for authorisation\n\n## Validation \u0026 Sanitisation\n\n- Using `express-validator` package (best validator package written in TypeScript)\n\n## REST API Specifications\n\nOpenAPI 3.1.0\n\n## How to run this application\n\nThis application can run either in a docker container or on your local machine.\n\n### Run in a container\n\n#### Build \u0026 Run\n\nAll dependencies will be installed in the container.\n\n`docker compose build --no-cache \u0026\u0026 docker compose up`\n\n#### Stop the container\n\n`CTRL + C`\nOR\n`docker compose stop`\n\n#### Remove the container\n\n`docker compose down`\n\n---\n\n### Run in a local machine\n\n#### Prerequisites\n\n- Install [Deno](https://docs.deno.com/runtime/)\n\n#### Install dependencies\n\n`deno install`\n\nAlthough this project is built with Deno, most dependencies come from NPM. To avoid dependencies downloaded from the internet everytime, I've set `{\"vendor\": true}` in `deno.json` file.\n\nSo when you run `deno install`, npm packages will go to `node_modules` directory, jsr packages will go to `vendor` directory.\n\nReference: [Vendoring remote modules](https://docs.deno.com/runtime/fundamentals/modules/#vendoring-remote-modules).\n\n#### Run the application\n\n`deno task start`\n\n- Server is running on port 3085\n- Swagger UI is running on port 3086\n\nTest the api from: [http://localhost:3086/api-docs](http://localhost:3086/api-docs)\n\n## License\n\nThe project is licensed under [Apache license 2.0](https://www.apache.org/licenses/LICENSE-2.0.txt).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyangbeibei88%2Ftafe-weather-rest-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyangbeibei88%2Ftafe-weather-rest-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyangbeibei88%2Ftafe-weather-rest-api/lists"}