mirror of
https://github.com/th3r00t/pyShelf.git
synced 2026-04-28 01:59:35 -04:00
Update README.md
This commit is contained in:
72
README.md
72
README.md
@@ -20,7 +20,7 @@ Follow or influence development @ <p align="center"><b>
|
|||||||
## Current Features
|
## Current Features
|
||||||
|
|
||||||
* Recursive Scanning
|
* Recursive Scanning
|
||||||
* Library Stored in PostgreSql database
|
* PostgreSql Library
|
||||||
* [Django](https://www.djangoproject.com/) based frontend
|
* [Django](https://www.djangoproject.com/) based frontend
|
||||||
* Basic seaching via a SearchVector of author, title, & file_name fields.
|
* Basic seaching via a SearchVector of author, title, & file_name fields.
|
||||||
* Ebook Downloading
|
* Ebook Downloading
|
||||||
@@ -58,13 +58,11 @@ Follow or influence development @ <p align="center"><b>
|
|||||||
* [x] Control panel
|
* [x] Control panel
|
||||||
* [x] Book details
|
* [x] Book details
|
||||||
|
|
||||||
## Installation Example
|
|
||||||
|
|
||||||
<a href="https://vimeo.com/382292764" target="_blank">pyShelf Installation Video</a>
|
|
||||||
|
|
||||||
## Installation & Support Information
|
## Installation & Support Information
|
||||||
|
|
||||||
* [SUPPORT.md](https://github.com/th3r00t/pyShelf/blob/development/.github/SUPPORT.md)
|
# Installation
|
||||||
|
|
||||||
|
This project is targeted towards Network Administrators, and home enthusiasts whom I assume will know how to setup a [Django](https://www.djangoproject.com/) app, and a [PostgreSQL](https://www.postgresql.org/) server. For those unfamiliar with the required setup please see the docker section below.
|
||||||
|
|
||||||
### Pre-req Dependencies
|
### Pre-req Dependencies
|
||||||
|
|
||||||
@@ -72,41 +70,32 @@ Follow or influence development @ <p align="center"><b>
|
|||||||
* python3
|
* python3
|
||||||
* pip
|
* pip
|
||||||
|
|
||||||
# Installation
|
setup configurations as discussed in [SUPPORT.md](https://github.com/th3r00t/pyShelf/blob/development/.github/SUPPORT.md)
|
||||||
|
|
||||||
This project is targeted towards Network Administrators, and home enthusiasts whom I assume will know how to setup a [Django](https://www.djangoproject.com/) app, and a
|
|
||||||
[PostgreSQL](https://www.postgresql.org/) server.
|
|
||||||
|
|
||||||
Once your environment is ready very little is required to get the system up and running:
|
Once your environment is ready very little is required to get the system up and running:
|
||||||
* From the main directory
|
|
||||||
* setup configurations as discussed in [SUPPORT.md](https://github.com/th3r00t/pyShelf/blob/development/.github/SUPPORT.md)
|
From the main directory
|
||||||
* Run the following commands
|
|
||||||
`
|
`pip install -r requirements.txt`
|
||||||
pip install -r requirements.txt
|
|
||||||
cd src
|
`cd src`
|
||||||
python manage.py makemigrations
|
|
||||||
python manage.py makemigration interface
|
`python manage.py makemigrations`
|
||||||
python manage.py migrate
|
|
||||||
python manage.py migrate interface
|
`python manage.py makemigration interface`
|
||||||
cd ..
|
|
||||||
./configure
|
`python manage.py migrate`
|
||||||
./importBooks
|
|
||||||
`
|
`python manage.py migrate interface`
|
||||||
|
|
||||||
|
`cd ..`
|
||||||
|
|
||||||
|
`./configure`
|
||||||
|
|
||||||
|
`./importBooks`
|
||||||
|
|
||||||
Browse to the site as defined in your apache | nginx config
|
Browse to the site as defined in your apache | nginx config
|
||||||
|
|
||||||
## Development
|
|
||||||
|
|
||||||
* [`pre-commit`](https://pre-commit.com/)
|
|
||||||
_Before developing, run `pre-commit install` See the [documentation](https://pre-commit.com/) for more information._
|
|
||||||
|
|
||||||
* ['Doxygen'](http://www.doxygen.nl/)
|
|
||||||
_Any changes to source should be documented and have run doxygen doxygen.conf prior to commiting._
|
|
||||||
|
|
||||||
* ['sem-ver'](https://semver.org)
|
|
||||||
_Before advancing version numbers be sure to set PROJECT_NUMBER in doxygen.conf accordingly._
|
|
||||||
|
|
||||||
## Configuration
|
|
||||||
|
|
||||||
Running via the [Django](https://www.djangoproject.com/) test server might be possible, albeit not recomended.
|
Running via the [Django](https://www.djangoproject.com/) test server might be possible, albeit not recomended.
|
||||||
|
|
||||||
## Docker
|
## Docker
|
||||||
@@ -173,6 +162,11 @@ The Docker image is still new, so there could still be some issues and missing f
|
|||||||
|
|
||||||
### Terminal Backend for catalogue maintenance
|
### Terminal Backend for catalogue maintenance
|
||||||
|
|
||||||
### Calculate page count from total characters
|
## Development
|
||||||
|
|
||||||
* (Thanks to @Fireblend for the idea) https://github.com/th3r00t/pyShelf/issues/3
|
* [`pre-commit`](https://pre-commit.com/)
|
||||||
|
_Before developing, run `pre-commit install` See the [documentation](https://pre-commit.com/) for more information._
|
||||||
|
* ['Doxygen'](http://www.doxygen.nl/)
|
||||||
|
_Any changes to source should be documented and have run doxygen doxygen.conf prior to commiting._
|
||||||
|
* ['sem-ver'](https://semver.org)
|
||||||
|
_Before advancing version numbers be sure to set PROJECT_NUMBER in doxygen.conf accordingly._
|
||||||
|
|||||||
Reference in New Issue
Block a user