Skip to content

Commit

Permalink
Merge pull request #15 from Baljit998/master
Browse files Browse the repository at this point in the history
Frappe 15 installation steps
  • Loading branch information
hsrai authored Jul 13, 2024
2 parents 3471a01 + 187c1eb commit bea8d81
Show file tree
Hide file tree
Showing 2 changed files with 165 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,3 +17,5 @@ Workshop for GD Members by the GD Members is the idea to share the knowledge to
1. [Web-page in Frappe](webpage_in_frappe.md) by [Diya Baweja](https://github.com/Diya050/).
1. [Working with Frappe UI](frappe_ui.md) by [Diya Baweja](https://github.com/Diya050/).
2. [Frappe Tutorial](tutorialfrappe.md) by [Jaspinder Kaur Walia](https://github.com/JaspinderKaurWalia26).
1. [Frappe Version 15 install](frappeinstall15.md) by [Baljit Singh ](https://github.com/Baljit998).

163 changes: 163 additions & 0 deletions frappeinstall15.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,163 @@
# Frappe-Installation Turorial
# Frappe Web Framework Installation

## Version 15
<h3><b> Step 1: Install WSL and Ubuntu </b></h3>

In windows powershell (Run as Administrator) run

wsl --install -d ubuntu

If you face an error while opening the installed distro in wsl (Even afterrestarting the system), try

wsl --update


After creating a new username and password, run

sudo apt-get update

Followed by

sudo apt-get upgrade

#### Alternatively you can also follow the below steps to install frappe on Ubuntu Server or Desktop also.

Create user. Note: Replace [frappe-user] with your username. Eg. sudo adduser myname

sudo adduser [frappe-user]
usermod -aG sudo [frappe-user]
su [frappe-user]
cd /home/[frappe-user]/
<h3><b> Step 2: Install Frappe Pre-requisites </b></h3>

We need to install the following prerequisite packages for Frappe V15

Python 3.10 or 3.11 pip 20+
Node.js 18 yarn 1.12+
MariaDB 10.6.6+ cron
Redis 6 NGINX
wkhtmltopdf (version 0.12.6 with patched qt)

#### Install Git
Use command

sudo apt-get install git

#### Python 3.10 & pip 20+
Use the following command to install the latest version of python 3

sudo apt-get install python3

Then run the following to install the latest version of pip

sudo apt install python3-pip

We also need the venv package to install frappe

sudo apt-get install virtualenv
sudo apt install python3-venv

#### Node.js 18
To install node.js we first install nvm

curl https://raw.githubusercontent.com/creationix/nvm/master/install.sh | bash

To use nvm immediately, run

source ~/.profile

Then install the correct version of node using

nvm install 18.12.0

#### Yarn 1.12+
To install yarn we need to install npm first

sudo apt-get install npm

Then we install the latest version of yarn using

sudo npm install -g yarn

#### Redis 6
Run the following command to install the latest version of redis

sudo apt-get install redis-server

#### wkhtmltopdf 12.6 (with patched qt)
Run the following set of commands to install the correct version of wkhtmltopdf and its dependencies

sudo apt-get install xfonts-75dpi
sudo apt-get install xfonts-base
wget https://github.com/wkhtmltopdf/packaging/releases/download/0.12.6.1-2/wkhtmltox_0.12.6.1-2.jammy_amd64.deb
sudo dpkg -i wkhtmltox_0.12.6.1-2.jammy_amd64.deb
rm wkhtmltox_0.12.6.1-2.jammy_amd64.deb

#### mariadb 10.6.6+
Run the following commands to install mariadb

sudo apt install software-properties-common
sudo apt-get update
sudo apt-get install mariadb-server
sudo mysql_secure_installation

(During the initial input for root password, just press enter and when prompted to change the root password, change it.)

Now we need to make the following changes to the mariadb configurations

sudo nano /etc/mysql/my.cnf

Add the following to the end of the file and save

[mysqld]
character-set-client-handshake = FALSE
character-set-server = utf8mb4
collation-server = utf8mb4_unicode_ci

[mysql]
default-character-set = utf8mb4

Then restart the server

sudo service mysql restart

Or stop and start the server if you face any issues with restart

sudo service mariadb stop
sudo service mariadb start

<h3><b> Step 3: Install Frappe Bench </b></h3>
Now that we've installed all the required prerequisites, we can install frappe.

#### Frappe Bench
Install frappe bench using the following pip command

sudo pip3 install frappe-bench

Now init a new bench instance (You can give any name after init in the following command)

bench init frappe-bench --frappe-branch version-15

#### Create a new site
Now cd into the created bench folder (frappe-bench in this case) and create a new site.

bench new-site site.local

If you face an issue with the mariadb, start mariadb services and try creating a new site again.

sudo service mariadb start

Then provide an administrator password for the super admin account of this site.

Give the following command to set the site as current site and to start the bench.

bench use site.local
bench start

Alternatively, you can just start the bench and serve the site on a different port.

bench --site site.local serve --port 8069

These are the steps to install frappe version 15. Visit https://github.com/gavindsouza/awesome-frappe to learn about other apps you can install.

0 comments on commit bea8d81

Please sign in to comment.