{"id":19504757,"url":"https://github.com/nice-digital/timelines","last_synced_at":"2025-02-25T22:12:36.617Z","repository":{"id":48874302,"uuid":"379942924","full_name":"nice-digital/timelines","owner":"nice-digital","description":"Provides reporting from Clickup timelines data","archived":false,"fork":false,"pushed_at":"2021-09-13T16:06:36.000Z","size":125,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":8,"default_branch":"main","last_synced_at":"2025-01-08T10:45:24.298Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"C#","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/nice-digital.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}},"created_at":"2021-06-24T13:57:35.000Z","updated_at":"2021-12-04T23:57:51.000Z","dependencies_parsed_at":"2022-08-19T14:51:50.307Z","dependency_job_id":null,"html_url":"https://github.com/nice-digital/timelines","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nice-digital%2Ftimelines","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nice-digital%2Ftimelines/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nice-digital%2Ftimelines/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nice-digital%2Ftimelines/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nice-digital","download_url":"https://codeload.github.com/nice-digital/timelines/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240754366,"owners_count":19852189,"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-10T22:27:08.727Z","updated_at":"2025-02-25T22:12:36.547Z","avatar_url":"https://github.com/nice-digital.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Timelines\nProvides reporting from Clickup timelines data\n\n## What is it?\nThis service pulls data from the Click-up project management software via and API and stores the data in a SQL database that is accessible to the Planning tools reports.\n\n## Stack\n### Project structure\n- NICE.Timelines.Common - contains models, constants and extension methods common to all projects\n- NICE.Timelines.ConsoleApp - Entry point, calls the ClickUp API\n- NICE.Timelines.DB - Converts and saves the ClickUp data to the database, contains models and migrations for Entity Framework\n- NICE.Timelines.Test - low-level unit tests, run via xUnit, asserted with Shouldly.\n\n### Technical stack\n- [.NET Core 5](https://github.com/dotnet/core/tree/main/release-notes/5.0)\n\t- [Shouldly](https://github.com/shouldly/shouldly) for .NET assertions\n\t- [xUnit.net](https://xunit.github.io/) for .NET unit tests\n\t- [Moq](https://github.com/moq/moq4) for mocking in .NET\n- [SQL Server](https://www.microsoft.com/en-gb/sql-server/sql-server-2017) as our database\n    - [Entity Framework Core](https://github.com/aspnet/EntityFrameworkCore) as an ORM\n    - [EF Core In-Memory Database Provider](https://docs.microsoft.com/en-us/ef/core/providers/in-memory/) for integration tests\n\n## Set up\n1. Install [SQL Server](https://www.microsoft.com/sql-server) and [SQL Server Management Studio (SSMS)](https://docs.microsoft.com/sql/ssms/download-sql-server-management-studio-ssms)\n2. Clone the project at https://github.com/nice-digital/timelines.git\n3. Open *NICE.Timelines.sln*\n4. Ensure NICE.Timelines.ConsoleApp is set as the startup project\n5. Update the values secrets.json file\n6. Press F5 to run the project in debug mode\n\n### Secrets.json\nThe application's uses appsettings.json to store configuration. However, since this is a public repository, confidential configuration information is stored in secrets.json\nIn order to run the application correctly (with it having access to a database and clickup api), you'll need to acquire (from another dev) or create a secrets.json file with the correct configuration information in. For more  information see: [https://docs.microsoft.com/en-us/aspnet/core/security/app-secrets?tabs=visual-studio](https://docs.microsoft.com/en-us/aspnet/core/security/app-secrets?tabs=visual-studio)\n\n## Entity Framework Migrations\nWe use Code first Entity Framework migrations to update the consultations database  \n - add a new property to the relevent class in NICE.Timelines.DB \u003e Models\n - in visual studio go to Tools \u003e NuGet Package Manager \u003e Package Manager Console\n - in the package manager console window run the command Add-Migration [give your migration a useful name] eg Add-Migration AddTaskCreationDate  \n\tThis will create a new migrations script in NICE.Timelines.DB \u003e Migrations\n - when NICE.Timelines.ConsoleApp is next run the changes in the migration script will be applied to SQL.   \n \tA new column will be created in __EFMigrationHistory to flag that the migration has been run.__\n\n## Good to know\nFor Developer notes see Confluence \u003e Contacts Data Base / Planning Tool Home \u003e Timelines Dev Notes","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnice-digital%2Ftimelines","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnice-digital%2Ftimelines","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnice-digital%2Ftimelines/lists"}