Skip to content
Rezaul Karim Shaon edited this page Jan 23, 2025 · 5 revisions

The requirements, and setup steps are defined here.

Prerequisite

  • Python 3.10 or above
  • JavaScript
  • Vue3

Clone the Project

Using SSH use the command below:

git clone git@github.com:rkshaon/BookShelf.git

Using HTTPS use the command below:

git clone https://github.com/rkshaon/BookShelf.git

Setup Backend

Navigate to Backend Directory

Execute the command below:

cd backend

Create Virtual Environment and Activate

Instructions

Install Dependencies

Execute the command below:

pip install -r requirements.txt

Migrate

Execute the commands below:

python manage.py makemigrations
python manage.py migrate

Create superuser

Execute the command below:

python manage.py createsuperuser

And fill up the information that propmpts.

Run the Project

Execute the command below:

python manage.py runserver

Populate Datas

Before start using you need to populate some data. Open the Django Shell and execute the commands below:

python manage.py shell

from configure_api.models import Timezone
Timezone.populate_timezones()

Setup Frontend

Navigate to Frontend Directory

Execute the command below:

cd frontend

Install Dependencies

Execute the command below:

npm install

Run the Server

Execute the command below:

npm run serve