Real-time code discussion and documentation on your IDE

Getting Started

To try out Doclin, install extension in VS Code. Link to VS Code Marketplace.

Currently only supports VS Code, but to be extended to other IDEs once we validate the concept.

What is Doclin?

Purpose

The purpose of this tool is to build code knowledgebase easily. Traditional code documentation methods is very inefficient. Writing code and documentation at the same time often resulted docs to be redundant, of no real-value, time-consuming and it quickly got out-of-date. We believe it is more helpful to document the answers when someone asks a question or faces a problem. This not only ensures the documentation is more meaningful, but we can spend less time in writing documentation.

Doclin is still in very early-stage. If you like the idea, please show support my star-ring this repository!

Usage

1. Ask questions on code from your IDE!
   

2. Get answers in real-time.
   

3. Discussions stay coupled with the code.
   

Local Setup Instructions

Pre-requisites

1. Node.js: Ensure you have Node.js installed (minimum version required: 14.x or higher).
2. PostgreSQL: Make sure you have a PostgreSQL database set up and running.
3. VS Code: Ensure you have the latest version of VS Code installed.

Run the server

1. Setup Database
   1. Install Postgres locally
   2. Create a database named "doclin"
2. Fill up the credentials in .env file
   1. DB_HOST and DB_PASS - These are credentials for your postgres server.
   2. ACCESS_TOKEN_SECRET - This is used to sign the JWT tokens. Use a random string for this.
   3. GITHUB_CLIENT_SECRET and GITHUB_CLIENT_ID - These are used for the github login. Get these by creating a Github app.
   4. SENDGRID_API_KEY - Optional. This is used for email notifications when someone is tagged on a thread. Get your own api key from Sendgrid.
   5. OPENAI_API_KEY - Optional. This is used for the copilot.

cd api
npm install
npm run watch
npm run dev

Run the extension

On Visual Studio Code, open the repository. Then on the top bar, select Run, then Start Debugging (F5).

Contributing

See CONTRIBUTING.md for ways you can contribute to Doclin.