Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/eddyoliveiram/bms
I developed a simple application for a book management system using the Yii framework. The application allows users to search for books based on various criteria such as title, author, genre, or publication date. Filtering tools help refine search results, making it easier to find specific books.
https://github.com/eddyoliveiram/bms
bootstrap jquery mvc-architecture yii
Last synced: about 22 hours ago
JSON representation
I developed a simple application for a book management system using the Yii framework. The application allows users to search for books based on various criteria such as title, author, genre, or publication date. Filtering tools help refine search results, making it easier to find specific books.
- Host: GitHub
- URL: https://github.com/eddyoliveiram/bms
- Owner: eddyoliveiram
- License: bsd-3-clause
- Created: 2024-01-16T15:49:24.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2024-02-11T23:58:57.000Z (12 months ago)
- Last Synced: 2024-12-15T02:39:21.508Z (about 2 months ago)
- Topics: bootstrap, jquery, mvc-architecture, yii
- Language: PHP
- Homepage:
- Size: 126 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
BMS - Book Management System
Written in Yii 2
This application is responsible for managing books, where users can register, login and request CRUD actions.
First Access
------------
Assuming you've already cloned this repository:
1º) Open the project and install the composer by running `composer install` on terminal.
2º) Open your SGBD and create a database called '`yii2basic`' which is the default settings of the `config/db.php` file.
3º) Open terminal and run the command `php yii migrate/fresh` to create all tables and fake data.
4º) On the terminal start the yii serve by running `php yii serve`, add a port if necessary, in this case `php yii serve -p 8888`.
5º) After the migrations ran succefully, you're ready to log in, the `admin admin` user was created and also 9 other users were randomly stored as well, all of them with a password equals `123` since it's stored in hash, you just need to check their usarnames in the table to be able to log in with their accounts.
6º) After logged in you're ready to make your first CRUD requests. Enjoyt it.
Main Rules
------------
~~~
1) Guest users have access only to login and signup pages.
2) Auth users have access to books with all CRUD actions allowed and also API access.
3) Auth users can't have access to login and signup pages while they are authenticated. In order to do so they must logout first.
~~~
Dependencies and Configuration
------------
### Dependencies I added via Composer
Faker to provide fake data for the migrations.
Httpclient for requests when consuming the API.
~~~
composer require --dev yiisoft/yii2-faker
composer require yiisoft/yii2-httpclient
~~~
### Manual config
I worked with the default database config in `config/db.php`
```php
return [
'class' => 'yii\db\Connection',
'dsn' => 'mysql:host=localhost;dbname=yii2basic',
'username' => 'root',
'password' => '',
'charset' => 'utf8',
];
```
Enabled prettyurl in `config/web.php`
~~~
'urlManager' => [
'enablePrettyUrl' => true,
'showScriptName' => false,
'rules' => [
],
],
~~~
Technical Descriptions
------------
### Controllers/
`IndexController` responsible for handling inital requests and user session.
```
behaviors() -> Control access to the methods below.
actionIndex() -> Displays the login form on the index page.
actionAttempt() -> Attempts to log in the user based on the provided credentials.
actionLogin() -> Displays the login form.
actionLogout() -> Logs the user out and redirects to the home page.
actionSingup() -> Displays the signup form.
actionRegister() -> Registers a new user.
```
`BookController` responsible for handling CRUD requests.
```
behaviors() -> Control access to the methods below.
actionIndex() -> Displays a list of all books.
actionCreate() -> Displays a form to create a book.
actionStore() -> Save the new book on database.
actionEdit() -> Displays the book editing form.
actionUpdate() -> Handles the book update process.
actionDestroy() -> Responsible for the book deletion process.
```
`ApiController` responsible for Api requests.
```
behaviors() -> Control access to the methods below.
actionIndex() -> Displays information about the weather in São Paulo.
```
### Models/
```
Author -> Model class for table author.
Book -> Model class for table author.
Bookform -> Model class for handling the creation of a book.
BookSeach -> Model class for handling any field search of the list.
LoginForm -> Model class for handling the login.
User -> Model class for table user.
```
### Views/
```
layouts/main -> Default view that handes all pages's structures
index/error -> View to display errors.
index/login -> View displaying the login form.
index/signup -> View displaying the sign up form.
book/index -> View displaying all books in a table.
book/edit -> View displaying the edit book form.
book/create -> View displaying the create book form.
api/_weather_details -> View part weather.
api/index -> View displaying weather info in São Paulo.
```
### Helpers/
```
WeatherHelper.php -> A view component that translates data and returns to the _weather_details.php
```
### Migrations/
```
m240116_161651_create_table_users -> create user table
m240116_171854_create_faker_users -> add fake data to users
m240117_181158_create_table_author -> create table author and add fake data
m240117_181212_create_table_book -> create table books and add fake data
```