Skip to content

Improve README with clearer local development setup#330

Open
Arijit429 wants to merge 4 commits intofireform-core:mainfrom
Arijit429:improve-readme-setup
Open

Improve README with clearer local development setup#330
Arijit429 wants to merge 4 commits intofireform-core:mainfrom
Arijit429:improve-readme-setup

Conversation

@Arijit429
Copy link

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

  • Added clear local setup instructions
  • Documented database initialization step
  • Added common error troubleshooting notes
  • Improved contributor onboarding experience

Impact

This change does not modify any application logic.
It enhances developer experience and project accessibility for new contributors.

@Arijit429
Copy link
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!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant