Dox

Inspiration

We were thinking of the difficulties that developers face initially. Hence, we began brainstorming ideas on how we could assist them on this.

What it does

Dox. helps developers understand any codebase in minutes. Simply drop your folder, and we generate instant documentation and dependency graphs so you can make your next steps easier.

How we built it

Frontend runs on Next.js, Typescript, and Javascript and is deployed to Vercel. Backend runs on Python, FastAPI, and Mermaid and is deployed to Railway.

Challenges we ran into

The challenges that we ran into during the project included the stage where we had to deploy. Initially, we weren't able to get it working for the backend. Eventually we realized that we put in the wrong environment variables, so when we got the changes made, it started running.

Accomplishments that we're proud of

Making a functional product with a lot of potential and scope. This is also an idea that is unique, not directed at just making profit but also at providing a service for the less-experienced developers.

What we learned

We learnt how to develop a product full-stack, understanding deployment and utilizing environmental variables, and understanding how to work and parse through files.

What's next for Dox

Integrate with GitHub, integrate with API so we can talk to LLM and analyze code more deeply to bring insights.

Built With

• cors
• fastapi
• javascript
• kroki
• mermaid
• next.js
• python
• railway
• react
• typescript
• uvicorn