FlashNotes
No description available.
File Explorer
Download Latest Version (.zip)- lint_backend.yml
- lint_frontend.yml
- test_backend.yml
- settings.json
- __init__.py
- config.py
- exceptions.py
- provider.py
- __init__.py
- .keep
- 4efa50e00bd4_add_indexes_to_foreign_keys_and_.py
- a4ee77cd028b_practice_sessions.py
- c8f918b058c6_.py
- cb16ae472c1e_.py
- cb7e65c8085b_add_user_cascade_delete_relationships.py
- d1ea38d75310_add_ai_usage_quota_tables.py
- env.py
- script.py.mako
- __init__.py
- api.py
- schemas.py
- services.py
- __init__.py
- config.py
- db.py
- __init__.py
- ai_config.py
- api.py
- exceptions.py
- models.py
- schemas.py
- services.py
- __init__.py
- api.py
- schemas.py
- services.py
- __init__.py
- api.py
- models.py
- schemas.py
- services.py
- __init__.py
- backend_pre_start.py
- initial_data.py
- main.py
- routers.py
- __init__.py
- test_api.py
- test_services.py
- __init__.py
- test_api.py
- test_services.py
- __init__.py
- test_api.py
- test_services.py
- __init__.py
- test_api.py
- test_services.py
- __init__.py
- conftest.py
- test_cascade_delete.py
- __init__.py
- test_test_pre_start.py
- __init__.py
- test_api.py
- test_services.py
- utils.py
- __init__.py
- conftest.py
- test_api.py
- test_services.py
- __init__.py
- user.py
- utils.py
- __init__.py
- conftest.py
- tests_pre_start.py
- .env.example
- .gitignore
- alembic.ini
- docker-compose.test.yml
- Dockerfile
- Dockerfile.pip
- entrypoint.sh
- prestart.sh
- pyproject.toml
- tests-start.sh
- uv.lock
- how-to-run-github-action-locally.md
- translation.json
- translation.json
- translation.json
- apple-touch-icon.png
- favicon-96x96.png
- favicon.ico
- favicon.svg
- preview_dark.mp4
- preview_light.mp4
- site.webmanifest
- web-app-manifest-192x192.png
- web-app-manifest-512x512.png
- contributors.json
- Logo.svg
- stars.json
- ApiError.ts
- ApiRequestOptions.ts
- ApiResult.ts
- CancelablePromise.ts
- OpenAPI.ts
- request.ts
- index.ts
- sdk.gen.ts
- types.gen.ts
- CardEditor.tsx
- CardHeader.tsx
- CardIListtem.tsx
- CollectionActionHeader.tsx
- CollectionDialog.tsx
- CollectionKebabMenu.tsx
- CollectionListItem.tsx
- EditorToolbar.tsx
- index.ts
- RichText.styles.css
- RichTextContent.tsx
- RichTextEditor.tsx
- useRichTextEditor.ts
- AiPromptDialog.tsx
- AnalyticsConsent.tsx
- Button.tsx
- CardSkeleton.tsx
- Drawer.tsx
- EmptyState.tsx
- ErrorState.tsx
- FloatingActionButton.tsx
- Footer.tsx
- GuestModeNotice.tsx
- Input.tsx
- LanguageSelector.tsx
- ListSkeleton.tsx
- LoadingState.tsx
- Navbar.tsx
- PasswordInput.tsx
- ScrollableContainer.tsx
- SpeedDial.tsx
- TextCounter.tsx
- PracticeCard.tsx
- PracticeComplete.tsx
- PracticeControls.tsx
- PracticeHeader.tsx
- MasteryDonutChart.tsx
- MostFailedCards.tsx
- PerformanceChart.tsx
- PracticeBarChart.tsx
- StatsGrids.tsx
- StatsSummaryGrid.tsx
- close-button.tsx
- color-mode.tsx
- dialog.tsx
- drawer.tsx
- menu.tsx
- password-input.tsx
- skeleton.tsx
- toaster.tsx
- tooltip.tsx
- cards.ts
- collections.ts
- practiceSessions.ts
- stats.ts
- flashcardsDB.ts
- useAuth.ts
- useAuthContext.tsx
- useCard.ts
- usePracticeSession.ts
- useTextCounter.tsx
- index.tsx
- analytics.ts
- ApiCardRepository.ts
- CardRepository.ts
- CardRepositoryFactory.ts
- LocalCardRepository.ts
- ApiCollectionRepository.ts
- CollectionRepository.ts
- CollectionRepositoryFactory.ts
- LocalCollectionRepository.ts
- ApiPracticeSessionRepository.ts
- LocalPracticeSessionRepository.ts
- PracticeSessionRepository.ts
- PracticeSessionRepositoryFactory.ts
- ApiStatsRepository.ts
- LocalStatsRepository.ts
- StatsRepository.ts
- StatsRepositoryFactory.ts
- $cardId.tsx
- new.tsx
- index.tsx
- practice.tsx
- stats.tsx
- index.tsx
- index.tsx
- login.tsx
- signup.tsx
- thanks.tsx
- __root.tsx
- _layout.tsx
- _publicLayout.tsx
- cards.ts
- collections.ts
- practiceSessions.ts
- stats.ts
- authUtils.ts
- stats.ts
- text.ts
- main.tsx
- routeTree.gen.ts
- theme.tsx
- utils.ts
- vite-env.d.ts
- .env.example
- .gitignore
- biome.json
- Dockerfile
- index.html
- openapi-ts.config.ts
- openapi.json
- package.json
- pnpm-lock.yaml
- tsconfig.app.json
- tsconfig.build.json
- tsconfig.json
- tsconfig.node.json
- vite.config.ts
- generate_client.sh
- .gitignore
- .pre-commit-config.yaml
- api_docs.png
- CONTRIBUTING.md
- docker-compose.yml
- LICENSE
- preview.gif
- README.md
# Installation Guide
1. Get the code
git clone https://github.com/0010aor/FlashNotes
Downloads the entire project code from GitHub to your computer.
cd FlashNotes
Moves into the project folder you just downloaded.
2. Docker
Easy RecommendedPrerequisites
- Git Needed to download the project code from GitHub.
- Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker compose -f backend/docker-compose.test.yml up -d --build
Runs the command against the services defined in the compose file.
Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.
3. Node.js
EasyPrerequisites
pnpm install
Downloads and installs the libraries listed in package.json.
pnpm run dev
Starts the development/run server.
After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.
Pulled directly from this repo's README.
4. Python
EasyPrerequisites
pip install .
Installs the package published on PyPI directly β no need to clone the source.
python <μ€νν νμΌλͺ
>.py # READMEμμ μ νν μ€ν νμΌλͺ
μ νμΈνμΈμ
Runs the Python script (or module).
If it runs without errors and prints output in the terminal, it worked.
// repository documentation
Was this content helpful?
(0 ratings)