diff --git a/README.md b/README.md index 5c2ee8ad..f3504509 100644 --- a/README.md +++ b/README.md @@ -29,6 +29,7 @@ The respective README files there contain more detailed descriptions. * [api](#api) * [api-skolplattformen](#api-skolplattformen) * [api-hjarntorget](#api-hjarntorget) + * [api-vklass](#api-vklass) * [curriculum](#curriculum) * [hooks](#hooks) * [Getting started with development](#getting-started-with-development) @@ -46,8 +47,8 @@ The respective README files there contain more detailed descriptions. The project consists of several apps and libraries inside [a NX](https://nx.dev/) monorepo. -### Apps -/apps/ contains the application projects. This is the main entry point for a runnable application. +### Apps +/apps/ contains the application projects. This is the main entry point for a runnable application. #### skolplattformen @@ -64,7 +65,7 @@ For more information, check out the [source code](apps/skolplattformen-app). The code for the website at https://skolplattformen.org/. It's built using Next.js. For more information, check out the [source code](apps/website). -### Libs +### Libs /libs/ contains the library projects. There are many different kinds of libraries, and each library defines its own external API so that boundaries between libraries remain clear. @@ -74,7 +75,11 @@ The base for all api implementations #### api-hjarntorget -The implementation for the school platform in Gothenburg called Hjärntorget +The implementation for the school platform in Gothenburg called Hjärntorget. + +#### api-vklass + +The implementation for the school platform Vklass. #### api-skolplattformen @@ -84,6 +89,7 @@ It also makes it easier for others to develop their own applications for the Sko **Pro tip:** If you don't want the API to make requests to the back-end, you can turn on _fake mode_ to return static data instead. \ Do so by logging in using 12121212121212 or 1212121212 as your personal identity number. Check out the documentation [here](libs/api-skolplattformen). + #### curriculum Translations of curriculum codes (sv: ämneskoder på schemat) to clear text descriptions @@ -95,7 +101,7 @@ Check out the documentation [here](libs/hooks). ## Getting started with Development -To clone and build the project, you first need to install [git](https://git-scm.com/), [node](https://nodejs.org/en/) and [yarn](https://classic.yarnpkg.com/lang/en/docs/install/). +To clone and build the project, you first need to install [git](https://git-scm.com/), [node](https://nodejs.org/en/) and [yarn](https://classic.yarnpkg.com/lang/en/docs/install/). Clone the repo with ```bash diff --git a/libs/api-vklass/project.json b/libs/api-vklass/project.json new file mode 100644 index 00000000..b13ae1b5 --- /dev/null +++ b/libs/api-vklass/project.json @@ -0,0 +1,23 @@ +{ + "root": "libs/api-vklass", + "sourceRoot": "libs/api-vklass/src", + "projectType": "library", + "targets": { + "lint": { + "executor": "@nrwl/linter:eslint", + "outputs": ["{options.outputFile}"], + "options": { + "lintFilePatterns": ["libs/api-vklass/**/*.{ts,tsx,js,jsx}"] + } + }, + "test": { + "executor": "@nrwl/jest:jest", + "outputs": ["coverage/libs/api-skolplattformen"], + "options": { + "jestConfig": "libs/api-vklass/jest.config.js", + "passWithNoTests": true + } + } + }, + "tags": [] +} diff --git a/libs/api-vklass/tsconfig.json b/libs/api-vklass/tsconfig.json index 96f33f53..b4fc9662 100644 --- a/libs/api-vklass/tsconfig.json +++ b/libs/api-vklass/tsconfig.json @@ -17,4 +17,4 @@ "**/__tests__/*", "**/__mocks__/*" ] -} \ No newline at end of file +} diff --git a/workspace.json b/workspace.json index 2bba53cc..3ab382d4 100644 --- a/workspace.json +++ b/workspace.json @@ -1,12 +1,13 @@ { "version": 2, "projects": { - "api": "libs/api", "api-hjarntorget": "libs/api-hjarntorget", "api-skolplattformen": "libs/api-skolplattformen", - "api-test-app": "apps/api-test-app", + "api-vklass": "libs/api-vklass", + "api": "libs/api", "curriculum": "libs/curriculum", "hooks": "libs/hooks", + "api-test-app": "apps/api-test-app", "skolplattformen-app": "apps/skolplattformen-app" } }