Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/imran110219/book_review_app


https://github.com/imran110219/book_review_app

bookreview django

Last synced: about 1 month ago
JSON representation

Awesome Lists containing this project

README

        

# Book Review Application

This application is designed for reviewing, rating books.

## Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

### Prerequisites

* Python 3.6.4
* Postgres

### Installing

A step by step series of examples that tell you have to get a development environment running

Download the python and install python.

```
https://www.python.org/downloads/
```

Download the Postgres and install it.

```
https://www.postgresql.org/download/
```

Install pip

```
$ easy_install pip
```

Create Virtual Environment

```
$ pip install virtualenv
$ cd Book_Review_App
$ virtualenv venv
$ venv\Scripts\activate
```

Install all package from requirements.txt

```
$ pip install -r requirements.txt
```

### Setup Database

Access postgres user

```
$ psql -U postgres
$ CREATE DATABASE bookreview;
```

Run migration

```
python manage.py makemigrations
python manage.py migrate
```

## Running the application

```
$ python manage.py runserver
```

### Break down into end to end tests

Explain what these tests test and why

```
Give an example
```

### And coding style tests

Explain what these tests test and why

```
Give an example
```

## Deployment

Add additional notes about how to deploy this on a live system

## Built With

* [Django](https://www.djangoproject.com/) - The web framework used
* [PostgreSQL](https://www.postgresql.org/) - Open Source Database

## Contributing

Please read [CONTRIBUTING.md](https://gist.github.com/PurpleBooth/b24679402957c63ec426) for details on our code of conduct, and the process for submitting pull requests to us.

## Versioning

We use [Git](https://gitforwindows.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/imran110219/Book_Review_App/commits/master).

## Authors

* **Sadman Sobhan** - *Backend Developer* - [imran110219](https://github.com/imran110219)
* **Md Shahjahan** - *Fullstack Developer* - [shahed48](https://github.com/shahed48)

See also the list of [contributors](https://github.com/imran110219/Book_Review_App/settings/collaboration) who participated in this project.

## License

This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details

## Acknowledgments

* Hat tip to anyone who's code was used
* Inspiration
* etc