Merge pull request #1181 from pateljannat/fix-readme

fix: readme
This commit is contained in:
Jannat Patel
2024-12-11 12:49:37 +05:30
committed by GitHub

View File

@@ -97,7 +97,7 @@ python3 ./easy-install.py deploy \
Replace the following parameters with your values: Replace the following parameters with your values:
- `your_email.example.com`: Your email address - `your_email.example.com`: Your email address
- `subdomain.domain.tld`: Your domain name where Insights will be hosted - `subdomain.domain.tld`: Your domain name where Learning will be hosted
The script will set up a production-ready instance of Frappe Learning with all the necessary configurations in about 5 minutes. The script will set up a production-ready instance of Frappe Learning with all the necessary configurations in about 5 minutes.
@@ -113,16 +113,16 @@ You need Docker, docker-compose and git setup on your machine. Refer [Docker doc
cd frappe-learning cd frappe-learning
# Download the docker-compose file # Download the docker-compose file
wget -O docker-compose.yml https://raw.githubusercontent.com/frappe/insights/develop/docker/docker-compose.yml wget -O docker-compose.yml https://raw.githubusercontent.com/frappe/lms/develop/docker/docker-compose.yml
# Download the setup script # Download the setup script
wget -O init.sh https://raw.githubusercontent.com/frappe/insights/develop/docker/init.sh wget -O init.sh https://raw.githubusercontent.com/frappe/lms/develop/docker/init.sh
**Step 2**: Run the container and daemonize it **Step 2**: Run the container and daemonize it
docker compose up -d docker compose up -d
**Step 3**: The site [http://lms.localhost:8000/insights](http://lms.localhost:8000/lms) should now be available. The default credentials are: **Step 3**: The site [http://lms.localhost:8000/lms](http://lms.localhost:8000/lms) should now be available. The default credentials are:
- Username: Administrator - Username: Administrator
- Password: admin - Password: admin
@@ -134,7 +134,7 @@ To setup the repository locally follow the steps mentioned below:
1. Start the server by running `bench start` 1. Start the server by running `bench start`
1. In a separate terminal window, create a new site by running `bench new-site learning.test` 1. In a separate terminal window, create a new site by running `bench new-site learning.test`
1. Map your site to localhost with the command `bench --site learning.test add-to-hosts` 1. Map your site to localhost with the command `bench --site learning.test add-to-hosts`
1. Get the Insights app. Run `bench get-app https://github.com/frappe/lms` 1. Get the Learning app. Run `bench get-app https://github.com/frappe/lms`
1. Run `bench --site learning.test install-app lms`. 1. Run `bench --site learning.test install-app lms`.
1. Now open the URL `http://learning.test:8000/lms` in your browser, you should see the app running 1. Now open the URL `http://learning.test:8000/lms` in your browser, you should see the app running