{"id":18283209,"url":"https://github.com/ungdev/etu-utt-api","last_synced_at":"2025-04-05T07:30:32.458Z","repository":{"id":248899251,"uuid":"623882206","full_name":"ungdev/etu-utt-api","owner":"ungdev","description":"UTT's student website API made with Nest.JS","archived":false,"fork":false,"pushed_at":"2025-03-20T10:14:50.000Z","size":3567,"stargazers_count":3,"open_issues_count":4,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-20T11:26:16.589Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ungdev.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}},"created_at":"2023-04-05T09:40:01.000Z","updated_at":"2025-03-13T23:16:15.000Z","dependencies_parsed_at":"2024-07-17T20:19:42.408Z","dependency_job_id":"dd3eac4d-45ec-41ed-a446-caf8d9da3bc5","html_url":"https://github.com/ungdev/etu-utt-api","commit_stats":null,"previous_names":["ungdev/etu-utt-api"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ungdev%2Fetu-utt-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ungdev%2Fetu-utt-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ungdev%2Fetu-utt-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ungdev%2Fetu-utt-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ungdev","download_url":"https://codeload.github.com/ungdev/etu-utt-api/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247305092,"owners_count":20917191,"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-11-05T13:08:10.923Z","updated_at":"2025-04-05T07:30:29.345Z","avatar_url":"https://github.com/ungdev.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# EtuUTT API : NestJS \u0026 Prisma\n\n## Setup with Docker\n\nCopy environment variables file and fill it with API keys and secrets.\n\n```sh\ncp .env.dist .env.dev\ncp .env.test.dist .env.test\n```\n\nStart the project (add a `-d` flag to run it in background)\n\n```sh\ndocker compose -f docker-compose.yml -f docker-compose.dev.yml up\n```\n\nEverytime that you `up` the project, it will do the following things for you in the background :\n\n- Check and install dependencies (Useful when installing the project for the first time or when switching branches).\n- Apply last changes on the `schema.prisma` to the database and update the prisma client.\n- Start Prisma Studio [on port 5555](http://localhost:5555).\n- Start the NestJS API in dev mode.\n\nPush database changes\n\n```sh\nnpx prisma db push\n```\n\n## Services\n\nYou can now go to [http://localhost:3000](http://localhost:3000) to see the app !\n\n| Service name | URL                                                 | Description                                                                                     |\n| ------------ | --------------------------------------------------- | ----------------------------------------------------------------------------------------------- |\n| API          | [http://localhost:3000](http://localhost:3000)      | The API home page. You can address all requests to that endpoint.                               |\n| API          | [http://localhost:3000/docs](http://localhost:3000) | The API Swagger documentation. You can read the functional documentation and try all endpoints. |\n\n## How to use\n\nTo open a terminal inside the container.\n\n```sh\ndocker exec -it etu-utt-api sh\n```\n\nInside that terminal, you can run any command you want, like this one to acces NestJS CLI.\n\n```sh\nnpx nest\n```\n\nTo run lint.\n\n```sh\nnpm run lint\n```\n\nTo run end to end tests (e2e) in watch mode.\n\n```sh\nnpm run test:e2e\n```\n\n## Setup manually\n\nSetup environment variables\n\n```sh\ncp .env.example .env\n```\n\nInstall dependencies\n\n```sh\nyarn\n```\n\nSetup the database\n\n```sh\nyarn prisma generate\nyarn prisma db push\n```\n\nStart the project\n\n```sh\n# In developping mode\nyarn start:dev\n# In debug mode\nyarn start:debug\n# In production\nyarn build\nyarn start:prod\n```\n\n## Contribute\n\nTo commit\n\n```sh\ngit cz\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fungdev%2Fetu-utt-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fungdev%2Fetu-utt-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fungdev%2Fetu-utt-api/lists"}