Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/linusbolls/code-study-planner
https://github.com/linusbolls/code-study-planner
Last synced: 13 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/linusbolls/code-study-planner
- Owner: LinusBolls
- Created: 2024-03-18T14:17:47.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-08-02T22:39:39.000Z (4 months ago)
- Last Synced: 2024-08-03T23:42:54.998Z (4 months ago)
- Language: TypeScript
- Homepage: https://planner.project.code.berlin
- Size: 1.49 MB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# study planner for CODE
a webapp that interacts with the graphql api of the code learning platform to help students plan their studies in advance and better understand their requirements.
## prerequisites
- [NodeJs](https://nodejs.org) >= 18.17.0
- [Docker](https://docs.docker.com/get-docker)
- [BunJs](https://bun.sh) (for running the seeding script)
## setup
##### (1) create a .env file matching the contents of .env.example
##### (2) start the docker container for the database
```bash
docker compose up
```
##### (3) run the seeding script for the database
this requires the additional `LP_ACCESS_TOKEN` environment variable, which can be the [learning platform access token](https://github.com/linusBolls/code-university-sdk/?tab=readme-ov-file#retrieving-an-access-token-from-the-code-learning-platform) of any account.
```bash
NODE_ENV=development bun run backend/seeding.ts
```
##### (4) install dependencies
```bash
npm install
```
##### (5) run the development server on http://localhost:3000
```bash
npm run dev
```
## contributing
study planner is open to PRs, issues, and general feedback!
## technical details
## use cases
- create your study plan by signing in with your access token
- drag and drop modules into your study plan
- preview your study progress and bachelor's grade
- get suggestions for your study plan
## clean code principles
### container/presentation pattern
components are as logic-less as possible and only used for presentation. logic is handled in hooks (e.g. ECTSPanel, useECTSPanel)
### encapsulation
logic for interacting with logic like useChatSelection or useLearningPlatform are encapsulated to make it easier to consume.
the StudyPlannerApiClient class is also an example of this, providing type safety for interacting with our api endpoints
### interface segregation
components don't depend on the inferred types of the database entities, but have their own types defined in `types.ts`, and are transformed into them in `mapping.ts`. this allows us to compute our own fields more easily and only have to react to learning platform api changes in a single place.