{"id":13566965,"url":"https://github.com/ingvaar/beauf-net-back","last_synced_at":"2025-04-04T00:32:30.689Z","repository":{"id":36962490,"uuid":"394410514","full_name":"ingvaar/beauf-net-back","owner":"ingvaar","description":"A simple quote website backend built using NestJS","archived":false,"fork":false,"pushed_at":"2025-02-20T03:07:57.000Z","size":2131,"stargazers_count":3,"open_issues_count":11,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-02-20T04:22:42.110Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","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/ingvaar.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":"2021-08-09T19:12:35.000Z","updated_at":"2025-02-20T03:08:00.000Z","dependencies_parsed_at":"2024-01-10T19:46:52.742Z","dependency_job_id":"208dca35-c921-4867-8f8b-966f73fbe477","html_url":"https://github.com/ingvaar/beauf-net-back","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ingvaar%2Fbeauf-net-back","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ingvaar%2Fbeauf-net-back/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ingvaar%2Fbeauf-net-back/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ingvaar%2Fbeauf-net-back/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ingvaar","download_url":"https://codeload.github.com/ingvaar/beauf-net-back/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247103290,"owners_count":20884023,"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":[],"created_at":"2024-08-01T13:02:20.451Z","updated_at":"2025-04-04T00:32:30.170Z","avatar_url":"https://github.com/ingvaar.png","language":"TypeScript","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"readme":"# Beauf.net - API\n\n###### Quotes API powered by\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://nestjs.com/\" target=\"blank\"\u003e\u003cimg src=\"https://nestjs.com/img/logo_text.svg\" width=\"320\" alt=\"Nest Logo\" /\u003e     \u003c/a\u003e\n\u003c/p\u003e\n\n### Deployment\n\nThis project uses [Docker](https://www.docker.com/) to deploy.\nThere is a production ready `Dockerfile` on the project's root.\nYou just have to build the Docker image to deploy/run the API.\nThe API is set to use a **PostgreSQL** database **only**.\n\n### Configuration\n\nWe are using the **environment** to configure the API.\nYou can find a `.env.example` at the project's root. The values defined are placeholders used for example purpose.\nFor a production deployments, these values must be set in the production environment.\n\n### Documentation\n\nThe API documentation is accessible via an embedded [Swagger](https://swagger.io/).\nIt can be accessed via `[api_url]/swagger`.\nEvery routes are described there.\n\n### Accessing the API\n\nThe default port of the API is `5000`, but this value can be changed in the `env`.\n\n### Development\n\n#### Usage\n\n**For development purpose only**, we are using Docker compose.\nEverything is embedded in the docker-compose (database, API, [Adminer](https://www.adminer.org/)).\nTo run the docker compose, use `docker-compose up --build`. We are using hot reload, so you don't have to restart the compose on each change.\nThe default port for [Adminer](https://www.adminer.org/) is `8080`.\nThe credentials for Adminer can be set in the env but the server will always be `db`.\n\nTo use the default values of the env, copy/paste the `.env.example` to a `.env` file, on the project's root.\n\n#### Migrations\n\nWhen you add a new `entity` to the project, you must use `yarn migrate` to generate a migration.\n\n#### Architecture\n\nThis project is based on [service pattern](https://en.wikipedia.org/wiki/Service_layer_pattern), following [NestJS example](https://github.com/nestjs/nest/tree/master/sample/01-cats-app/).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fingvaar%2Fbeauf-net-back","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fingvaar%2Fbeauf-net-back","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fingvaar%2Fbeauf-net-back/lists"}