|
| 1 | +<div align="center"> |
| 2 | + |
1 | 3 | # CodeGraph - Knowledge Graph Visualization Tool |
2 | 4 |
|
3 | | -### Visualize your repository with our graph for code analysis |
| 5 | +**Visualize codebases as knowledge graphs to analyze dependencies, detect bottlenecks, and optimize projects.** |
4 | 6 |
|
5 | 7 | [](https://app.falkordb.cloud) |
6 | 8 | [](https://hub.docker.com/r/falkordb/falkordb/) |
|
10 | 12 |
|
11 | 13 | **[Live Demo](https://code-graph.falkordb.com/)** |
12 | 14 |
|
| 15 | +</div> |
| 16 | + |
13 | 17 | ## Project Structure |
14 | 18 |
|
15 | 19 | ``` |
@@ -72,6 +76,13 @@ Copy the template and configure: |
72 | 76 | cp .env.template .env |
73 | 77 | ``` |
74 | 78 |
|
| 79 | +| Variable | Description | Required | Default | |
| 80 | +|----------|-------------|----------|---------| |
| 81 | +| `OPENAI_API_KEY` | Your OpenAI API key for code analysis | Yes | - | |
| 82 | +| `SECRET_TOKEN` | User-defined token for request authorization | Yes | - | |
| 83 | +| `FALKORDB_HOST` | FalkorDB server hostname | No | localhost | |
| 84 | +| `FALKORDB_PORT` | FalkorDB server port | No | 6379 | |
| 85 | + |
75 | 86 | Edit `.env` with your values: |
76 | 87 |
|
77 | 88 | ```bash |
@@ -204,13 +215,23 @@ Support for additional languages is planned. |
204 | 215 | | POST | `/list_commits` | List commits of a repository | |
205 | 216 | | POST | `/switch_commit` | Switch to a specific commit | |
206 | 217 |
|
207 | | -## Community |
| 218 | +## Contributing |
208 | 219 |
|
209 | | -Have questions or feedback? Reach out via: |
| 220 | +We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details. |
210 | 221 |
|
211 | | -* [GitHub Issues](https://github.com/FalkorDB/code-graph/issues) |
212 | | -* Join our [Discord](https://discord.com/invite/6M4QwDXn2w) |
| 222 | +## License |
213 | 223 |
|
214 | | -If you find this repository helpful, please consider giving it a star! |
| 224 | +This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. |
215 | 225 |
|
216 | | -Knowledge Graph, Code Analysis, Code Visualization, Dead Code Analysis, Graph Database |
| 226 | +## Support |
| 227 | + |
| 228 | +- [GitHub Issues](https://github.com/FalkorDB/code-graph/issues) |
| 229 | +- [Discord](https://discord.com/invite/6M4QwDXn2w) |
| 230 | +- [Documentation](https://docs.falkordb.com) |
| 231 | +- Email: support@falkordb.com |
| 232 | + |
| 233 | +--- |
| 234 | + |
| 235 | +<div align="center"> |
| 236 | +If you find this repository helpful, please consider giving it a star! |
| 237 | +</div> |
0 commit comments