ashrafee-dev / ashrafee-dev/scamshield-api
Document backend environment variables
Open
Beginner friendly
Nobody has claimed this yet.
good first issue
- Dominant language
- Python
- Stars
- 3
- Forks
- 10
- Avg merge
- 14h 44m
- Merged PRs (30d)
- 9
Description
Goal
Make local setup easier by documenting the environment variables used by the backend.
Acceptance criteria
- Document
DEEPSEEK_API_KEY. - Document
MAX_FILE_SIZE, including that it is measured in bytes and has a 25 MiB default. - Link to
example.envfrom the setup instructions.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the backend setup instructions and example.env. Document DEEPSEEK_API_KEY and MAX_FILE_SIZE, including its byte units and 25 MiB default, then link example.env from the setup instructions. Done means all three acceptance criteria are visible to someone following local setup.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- fastapi, python
- Domain
- backend, documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Active
- Clarity
- Clearly specified
- Newbie friendliness
- 88/100