Skip to content

Commit ad1e4f4

Browse files
authored
Merge pull request #9 from SundeepChand/docs/update-readme
Added instructions for docker setup
2 parents ea11299 + 0254938 commit ad1e4f4

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,13 @@ In the project directory, you can run:
1212

1313
After cloning this repository you will need to install all the dependencies: `npm i`
1414

15-
This repository uses [EOS/eos-strapi](https://gitlab.com/SUSE-UIUX/eos-strapi) as the backend Strapi server. Follow these instructions to [set it up](https://gitlab.com/SUSE-UIUX/eos-strapi#how-to-install-it).
15+
There are two options to set up the `backend` for this repository:
1616

17-
Now you need to connect to the Strapi server. To do this, duplicate the file `src/config.json.template` into a new file called `src/config.json` and replace the content of the variable with your server URL.
17+
1. If you are planning to work only on the UI/UX of `eos-user-story`, then follow along. Skip to point 2 if you need to setup backend as well. For setting up using `docker`, first make sure you have `docker` & `docker-compose` installed ([Install instructions](https://docs.docker.com/engine/install/)). Next, run `docker-compose up` and wait for the server to start on `http://localhost:1337`. Visit [http://localhost:1337/admin/auth/](http://localhost:1337/admin/auth/) and create the admin user for Strapi. Then set the roles and permissions for the api endpoints. That's it, the backend is up and running. Proceed to the next paragraph for further instructions.
18+
19+
2. This repository uses [EOS-uiux-Solutions/strapi](https://github.com/EOS-uiux-Solutions/strapi) as the backend Strapi server. Follow [these](https://github.com/EOS-uiux-Solutions/strapi#how-to-install-it) instructions to set it up.
20+
21+
After setting up the backend, you need to connect the frontend to the Strapi server. To do this, duplicate the file `src/config.json.template` into a new file called `src/config.json` and replace the content of the variable with your server URL.
1822

1923
Then run: `npm start` to run the app in the development mode.
2024

0 commit comments

Comments
 (0)