You'll only need the following to get started:
Postgres
The best and largest open-source database in the world. You can use it for free, and it's very reliable.
Hosting You can host it anywhere you want - we have a container image for you to use, a Kubernetes deployment template, or you can host it on Heroku, or you can host it on your own server. It's up to you.
git clone https://github.com/dotmethodme/storywise.git
cd storywise
docker compose up
1. Create a database Depending on your cloud of choice, you can create a postgres database anywhere you prefer. Some free* options are:
2. Deploy storywise
You can choose from a whole host of options to deploy storywise. Some easy options are:
*not guaranteed free, since it entirely depends on how you use the free tiers of various cloud services.
Live demo:
https://demo.joinstorywise.com/admin
Github repository:
https://github.com/dotmethodme/storywise
Docker image:
https://hub.docker.com/r/mihainueleanu/storywise
Kubernetes deployment template:
/kubernetes/everything.yaml
Helm chart/charts
Docker-compose template:
/docker-compose.yaml
One of the simpler ways to deploy storywise is via docker-compose. This could be especially useful to try it out locally.
Start by cloning the repository:
git clone [email protected]:dotmethodme/storywise.git
cd storywise
Make sure to update the environment variables in the docker-compose file (or (env file)https://docs.docker.com/compose/environment-variables/set-environment-variables/#use-the-env_file-attribute) with new values relevant for your setup:
Then run:
docker compose up
You can deploy Storywise on Kubernetes using the following template: storywise/blob/main/kubernetes/everything.yaml
Start by cloning the repository:
git clone [email protected]:dotmethodme/storywise.git
cd storywise/kubernetes
Make sure to update the configmap.yaml and secret.yaml with new values relevant for your setup:
Another thing to update is the ingress address: here you want to configure the domain name that you've already setup to point to your Kubernetes cluster.
Note: if you wish to deploy in a namespace other than storywise, make sure to update that as well, everywhere in the yaml file
Once that's done, apply the yaml file:
kubectl apply -f .
And that's all. The admin panel of Storywise is available at https://your.address.example.com/admin, and you can login using the credentials you configured in the steps above (STORYWISE_USERNAME, and STORYWISE_PASSWORD).
Instructions to embed the analytics script into your website are available under the info tab inside the storywise admin (step above): https://your.address.example.com/admin
However, generally speaking the tracking script is available at the following address:
https://your.address.example.com/js/script.js
The project is going through active development, and obviously, as you might be able to judge by the questionable quality of this article, the documentation can also be improved.
If you enjoy Storywise, and would like to help, please consider giving back to the project and contributing to either the documentation, or the core project itself.
For any queries, please contact [email protected].
Thank you!
Storywise is built using the following very simple and accessible technologies:
For hosting, I prefer to use Kubernetes, but you can use whatever you want. I've also included a docker-compose file, and a deployment template for Kubernetes. And I welcome any contributions for other hosting options.