Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mavenium/librarymanagement
A simple project to manage the library.
https://github.com/mavenium/librarymanagement
django django-application django-project django-rest-framework docker-compose dockerfile python python3 rest-api
Last synced: 25 days ago
JSON representation
A simple project to manage the library.
- Host: GitHub
- URL: https://github.com/mavenium/librarymanagement
- Owner: mavenium
- Created: 2021-06-12T14:27:26.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2021-06-12T19:48:13.000Z (over 3 years ago)
- Last Synced: 2024-11-17T08:15:00.197Z (3 months ago)
- Topics: django, django-application, django-project, django-rest-framework, docker-compose, dockerfile, python, python3, rest-api
- Language: Python
- Homepage:
- Size: 32.2 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Library Management
A simple project to manage the library.
------------
### Author
- Mahdi Namaki, Full-Stack Developer (@mavenium)
------------
### Features
- Author CRUD
- Publisher CRUD
- Book CRUD
- API
------------
### How to install and run manually (GNU/Linux and Mac)
1. Install `git`,`python3`, `pip3`, `virtualenv` in your operating system
2. Create a development environment ready by using these commands
```
git clone https://github.com/mavenium/LibraryManagement # clone the project
cd LibraryManagement # go to the project DIR
virtualenv -p python3 .venv # Create virtualenv named .venv
source .venv/bin/activate # Active virtualenv named .venv (workon venv)
pip install -r requirements.txt # Install project requirements in .venv
python manage.py migrate # Create database tables
python manage.py collectstatic # Create statics files
python manage.py InitializeAdmin # create default admin user
python manage.py runserver # Run the project
```
3. Go to `http://127.0.0.1:8000/` to use project
------------
### How to install and run in Docker
```
git clone https://github.com/mavenium/LibraryManagement # clone the project
cd LibraryManagement # go to the project DIR
sudo docker-compose up # bilt all images and run
```
##### To run, you need to create the required volumes!
------------
### APIs
```
http://127.0.0.1:8000/api/v1/authors/ # JSON objects of authors
http://127.0.0.1:8000/api/v1/publishers/ # JSON objects of publishers
http://127.0.0.1:8000/api/v1/books_by_author// # JSON objects of books by author pk
http://127.0.0.1:8000/api/v1/books_by_publisher// # JSON objects of books by publisher pk
http://127.0.0.1:8000/api/v1/books_create/ # Create book object
```