diff --git a/.devcontainer/devc-welcome.md b/.devcontainer/devc-welcome.md new file mode 100644 index 00000000..8560a578 --- /dev/null +++ b/.devcontainer/devc-welcome.md @@ -0,0 +1,26 @@ +# Welcome to DocsGPT Devcontainer + +Welcome to the DocsGPT development environment! This guide will help you get started quickly. + +## Starting Services + +To run DocsGPT, you need to start three main services: Flask (backend), Celery (task queue), and Vite (frontend). Here are the commands to start each service within the devcontainer: + +### Vite (Frontend) + +```bash +cd frontend +npm run dev -- --host +``` + +### Flask (Backend) + +```bash +flask --app application/app.py run --host=0.0.0.0 --port=7091 +``` + +### Celery (Task Queue) + +```bash +celery -A application.app.celery worker -l INFO +``` diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json index a86b8b66..16188e32 100644 --- a/.devcontainer/devcontainer.json +++ b/.devcontainer/devcontainer.json @@ -13,6 +13,12 @@ "esbenp.prettier-vscode", "dbaeumer.vscode-eslint" ] - } + }, + "codespaces": { + "openFiles": [ + ".devcontainer/devc-welcome.md", + "CONTRIBUTING.md" + ] + } } } \ No newline at end of file diff --git a/README.md b/README.md index 0ae8ec99..ba042bd8 100644 --- a/README.md +++ b/README.md @@ -45,11 +45,11 @@ - [x] Full GoogleAI compatibility (Jan 2025) - [x] Add tools (Jan 2025) +- [x] Manually updating chunks in the app UI (Feb 2025) +- [ ] Devcontainer for easy development (Feb 2025) - [ ] Anthropic Tool compatibility - [ ] Add triggerable actions / tools (webhook) - [ ] Add OAuth 2.0 authentication for tools and sources -- [ ] Manually updating chunks in the app UI -- [ ] Devcontainer for easy development - [ ] Chatbots menu re-design to handle tools, scheduling, and more You can find our full roadmap [here](https://github.com/orgs/arc53/projects/2). Please don't hesitate to contribute or create issues, it helps us improve DocsGPT!