README.md

@@ -0,0 +1,42 @@
+# Getting started
+Fastest way to get started is with docker. Make sure that is installed before moving forward.
+
+This application requires `textsender_auth` and `catapult` repositories to be located in the
+parent directory.
+
+```
+.
+..
+- textsender_auth/
+- textsender_api/
+- catapult/
+```
+
+Make sure the othe repositories are configured as it is required to operate successfully.
+
+Copy over the `.env.docker.sample` to `.env` to get started.
+
+### Token service
+The `JWT_SECRET` environment variable should be the same variable as `SECRET_MAIN_KEY` in
+`textsender_auth`.
+
+### Messaging configuration
+textsender uses `twilio` as the service to send the messages. You will need to sign up with
+them and be provided an account SID, service SID, auth token, and phone number. Update the
+corresponding `TWILIO_*` variables.
+
+
+### Database configuration
+Make sure to provide values for the `DB_MAIN_*` variables. For the sake of development, it
+can be left as it is.
+
+
+Build the container
+```
+docker build
+```
+
+Run the container
+```
+docker compose up
+```