diff --git a/.gitignore b/.gitignore index 38340e8..f6eb13c 100644 --- a/.gitignore +++ b/.gitignore @@ -1,5 +1,3 @@ -LICENSE -README.md .env.prod .env.dev -__pycache__ \ No newline at end of file +__pycache__ diff --git a/docs/LICENSE b/docs/LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/docs/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..b475798 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,173 @@ +# CertStack +Quizlet-like platform for studying for professional certification/licensing exams, focused on but not limited to state regulated licensing (i.e. Bar Exam, USMLE, CPA, etc). + +## Backend Overview (`src/server`) + +The backend is a layered FastAPI app: + +1. `server.py` bootstraps FastAPI, CORS, and mounts routers. +2. `routes/` defines HTTP endpoints and request auth requirements. +3. `controllers/` handles request orchestration and maps domain errors to HTTP errors. +4. `services/` contains business logic and throws typed app-level errors (`AppError`). +5. `schemas/` defines request/response contracts with Pydantic models. + +Current entrypoint: + +- `src/server/server.py` +- Mounts `jwt_auth.services.auth_services` (from `jwt-auth` dependency) +- Mounts local business routes from `src/server/routes/example_route.py` + +### Request Flow + +1. Client calls a route in `routes/*`. +2. Route validates input via `schemas/*` and validates token with `decode_access_token`. +3. Route calls controller. +4. Controller calls service. +5. Service returns data or raises `AppError`. +6. Controller converts `AppError` into `HTTPException` with the right status code. + +## Backend Setup + +Create env files: + +- Copy `src/server/.env.example` into: + - `src/server/.env.dev` + - `src/server/.env.prod` +- Fill in DB and JWT values. + +Run backend locally with Docker Compose: + +```bash +cd src/infrastructure +docker compose up --build server redis +``` + +Health check: + +- `GET http://127.0.0.1:8000/` -> `{ "status": "healthy" }` + +Run full local stack (client + server + redis): + +```bash +cd src/infrastructure +docker compose up --build +``` + +Useful Docker commands: + +```bash +# stop containers +docker compose down + +# restart only backend services +docker compose up --build -d server redis + +# backend logs +docker compose logs -f server +``` + +## How to Implement New Backend Code + +Use this order for every feature. + +### 1) Add/Update Schemas + +Create a request model in `src/server/schemas/schema.py` (or a new schema module): + +```python +from pydantic import BaseModel +from typing import Optional + +class CreateThingRequest(BaseModel): + name: str + description: Optional[str] = None +``` + +### 2) Add Service Logic + +Add pure business logic in `src/server/services/service.py` (or a feature-specific service file): + +```python +class AppError(Exception): + def __init__(self, message: str, status_code: int = 400): + self.message = message + self.status_code = status_code + super().__init__(message) + +def create_thing_service(name: str): + if not name: + raise AppError("name is required", 400) + return {"name": name} +``` + +### 3) Add Controller + +Controllers call services and normalize errors: + +```python +from fastapi import HTTPException +from services.service import create_thing_service, AppError + +def create_thing_controller(request): + try: + return create_thing_service(request.name) + except AppError as error: + raise HTTPException(detail=error.message, status_code=error.status_code) +``` + +### 4) Add Route + +Expose the endpoint in `src/server/routes/`: + +```python +from fastapi import APIRouter, Depends +from fastapi.security import OAuth2PasswordBearer +from jwt_auth.services.auth_services import decode_access_token +from controllers.example_controller import create_thing_controller +import schemas.schema as schema + +router = APIRouter() +oauth2_scheme = OAuth2PasswordBearer(tokenUrl="/auth/login") + +@router.post("/things") +def create_thing(request: schema.CreateThingRequest, token: str = Depends(oauth2_scheme)): + decode_access_token(token) + return create_thing_controller(request) +``` + +### 5) Register Router (if new router file) + +In `src/server/server.py`, import and mount the new router: + +```python +from routes.things_route import router as things_router +app.include_router(things_router) +``` + +## Auth and Route Protection + +- Protected routes use `OAuth2PasswordBearer(tokenUrl="/auth/login")`. +- The bearer token is validated via `decode_access_token(token)`. +- Invalid tokens return `401` automatically from the auth helper. + +## Data and LLM Utilities + +- `src/server/data/` contains source exam JSON and parsing utilities. +- `src/server/controllers/example_controller.py` includes `update_Database(path)` for loading JSON questions into Upstash Vector DB using OpenAI embeddings. +- For production, prefer API-based secret loading over interactive `getpass` prompts. + +## Contributing + +Branching model: + +- `prod`: stable production branch +- `testing`: integration and pre-release testing +- `feature/*`: individual feature/fix branches + +Workflow: + +1. Branch from `testing`. +2. Implement and commit scoped changes. +3. Merge latest `testing` into your feature branch before PR. +4. Open PR from `feature/*` -> `testing` (Or pull `feature/*` into testing). +5. CI promotes `testing` -> `prod` after checks pass.