grafit is an MIT-licensed web app that allows teams to store, share and search knowledge in an effective way. With intelligent relation detection, different data sources are presented and searchable at one central entry point.
User Guide
The user documentation is available here.
Developer Guide
The documentation for developers is available here. If you want to contribute to this project please follow the contributing guidelines here.
Deployment
Grafit can be deployed via a docker-compose file. The prerequisite for this is that you have Docker and Docker-Compose installed on the target machine.
Instructions can be found here:
Install Docker Mac / Windows
Once Docker is installed the current production docker-compose file can be downloaded with the following curl command:
curl https://raw.githubusercontent.com/grafit-io/grafit/master/docker-compose.yml -o docker-compose.yml
Next all containers can be startet with the docker-compose command:
docker-compose up
Once all containers have started the following actions can be taken:
- Go to http://localhost:3000 to start the app.
- Go to http://localhost:8001 to read the docs.
More about the different containers can be read here.