Skip to content

Commit

Permalink
Rewrite in Svelte & Bump to 0.2 (Merge #16)
Browse files Browse the repository at this point in the history
  • Loading branch information
PineappleRind authored Sep 18, 2023
2 parents 0c4ad19 + 4bf0160 commit 482d32d
Show file tree
Hide file tree
Showing 93 changed files with 2,977 additions and 3,271 deletions.
4 changes: 3 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,6 @@ bun.lockb
build
docs

*.ignore.*
*.ignore.*

.svelte-kit
3 changes: 3 additions & 0 deletions .prettierrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"tabWidth": 4
}
58 changes: 14 additions & 44 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,49 +11,19 @@ Helps to study latin declensions/vocabulary
*(Henle Latin, Christian/Classical)*

## Running locally
- use the Runner to run, over at [scripts/build.sh](https://github.com/PineappleRind/latinstudy/blob/main/scripts/build.sh) (you may need to chmod +x if permission denied)
- run it with the `--help` flag for advanced usage
All commands listed can be replaced with your favorite package manager :)
1. `bun i` — install dependencies
2. `bun dev` — run "dev" script
3. `open localhost:5173` — open in browser!

## Docs
To build documentation, run scripts/docs.sh. Documentation is in the .gitignore because it's not part of the project :)

## Guide to the codebase
> A simple index of files and folders. Real docs coming soon (see issue #2)
- `css`: css style files
- `data`: json data for endings, vocab, etc
- `scripts`: shell scripts for local development
- `src`: main logic
- - `components`: visual components such as popups
- - `dataHandlers`: code for dealing with data: fetches the data and parses it
- - `quiz`: main code for the quiz
- - - `components`: components specific to the quiz
- - - `Initializer, Formulator, WalkthroughMan, Grader`: logic dealing with the quiz itself, per-step
- - - `formulators`: helpers for `Formulator`
- - - `walkthroughHelpers`: helpers for `WalkthroughMan`
- - `view`: main code for the view section
- - - `loader`: main code for this section. split this into multiple files later

## Commits
Commits should have a list of changes in their description.

An example change:

`fs: move types to their own files`

The left descriptor can be one of `build, refactor, fs, opt, feat, rm`.

Additional information should be directly under the change and should have "———" 3 em dashes at the beginning, to differentiate it from the other changes.

Example description:

```
build: run script does not build anymore
fs: move dataHandlers/index.ts to dataHandlers/DataHandler.ts
—— classes should not be in the index (except root)
fs: Endings.ts -> EndingParser.ts (same with vocab)
feat: begin MagicValue parser
```

You don't actually need to follow this, it's just a guideline I follow for consistency. :)
- `README.md`: you are here
- `static`: static assets that will not be processed by Svelte
- `src`: main ui/logic
- - `components`: reusable components or functionality extracted from pages/layouts
- - `routes`: each page and its logic
- - - `api`: backend api routes
- - - `quiz`: quiz-related routes
- - - `view`: learn-related routes
- - `types`: shared types between api/routes
- - `utils`: reusable functions
6 changes: 6 additions & 0 deletions biome.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"$schema": "./node_modules/@biomejs/biome/configuration_schema.json",
"formatter": {
"ignore": ["src/routes/api/data/*.json"]
}
}
Loading

1 comment on commit 482d32d

@vercel
Copy link

@vercel vercel bot commented on 482d32d Sep 18, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

latinstudy – ./

latinstudy-pineapplerind.vercel.app
latinstudy-git-main-pineapplerind.vercel.app
latinstudy.vercel.app

Please sign in to comment.