Improve README with clearer local development setup#330
Open
Arijit429 wants to merge 4 commits intofireform-core:mainfrom
Open
Improve README with clearer local development setup#330Arijit429 wants to merge 4 commits intofireform-core:mainfrom
Arijit429 wants to merge 4 commits intofireform-core:mainfrom
Conversation
Author
|
Hi mentors 👋 I am currently trying to understand the overall FireForm architecture (especially Controller → FileManipulator → LLM flow). While exploring the codebase and contributing small fixes, I was wondering which areas of the project would benefit most from deeper contributions for GSoC. I would really appreciate any guidance on priority features or technical directions to explore. Thanks! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
While onboarding to the project, I noticed that some important local setup steps such as database initialization and handling common runtime issues were not clearly documented.
This PR improves the README by adding a beginner-friendly local development setup section. It provides step-by-step instructions for creating a virtual environment, installing dependencies, initializing the database, running the FastAPI server, and accessing the Swagger UI.
Additionally, a short troubleshooting section has been included to help new contributors quickly resolve common errors such as missing database tables or Ollama connectivity issues.
Motivation
Improving onboarding documentation can significantly reduce initial setup friction for new contributors and help them start contributing faster. These additions are based on real issues encountered during local project setup.
Changes Made
Impact
This change does not modify any application logic.
It enhances developer experience and project accessibility for new contributors.