About ReadsHub
ReadsHub is a web application that allows users to share their favorite books with some functionality such as:
- Discover the Books shared by others.
- Manage their shared Books (List, Add, Update, and Delete).
Backend Docs
Includes
- Django
- Django REST framework
- Vue 2
- Vue Router
- Vuex
Project Structure
Location | Content |
---|---|
/backend |
Django Project & Backend Config |
/frontend |
Vue App . |
Prerequisites
Before getting started you should have the following installed and running:
- NPM – instructions
- Vue CLI – instructions
- Python 3 – instructions
- Pip – instructions
Setup
$ git clone https://github.com/khalidzeiter/readsHub.git
$ cd readsHub
$ cd frontend
$ npm install
$ cd ../backend
$ pip install -r requirements.txt
$ python manage.py migrate
Running Development Servers
$ cd backend
$ python manage.py runserver
$ cd backend
$ npm run serve
The Vue application will be served from localhost:8080
and the Django API and static files
will be served from localhost:8000
.