Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/otaaaviio/library-vue
https://github.com/otaaaviio/library-vue
Last synced: 21 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/otaaaviio/library-vue
- Owner: otaaaviio
- Created: 2024-05-27T22:39:12.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-06-14T16:48:31.000Z (5 months ago)
- Last Synced: 2024-06-14T18:05:47.003Z (5 months ago)
- Language: Vue
- Size: 794 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Library with Vue
## Overview
This is a front-end project of a library that was developed with Vue.js. The project was developed with the intention of showcasing my skills with Vue.js and web application development.
## Key Features
### User Registration and Authentication
Our system allows users to register and log in, ensuring that only authenticated users can perform certain operations within the site.
### Book Management
The system allows users to view, add, edit, and delete books. Books can be searched by title, author, publisher, or category.
### Reviews
The system contains a review system that allows users to rate books and view their reviews made.
### Reading Book List
Users can add books to a reading list, allowing them to keep track of the books they want to read and mark which books they have read or not.
### Multi-Language Support
The system supports several languages, allowing users to choose the language of their preference. Among them, we have:
- Portuguese
- English
- Spanish
### Theme Switcher
The system allows users to choose between a light theme and a dark theme, allowing them to customize the appearance of the site according to their preferences.
### Docker
The system is containerized using Docker, making it easy to deploy and scale.
### Aditional information
I attach some site pics for better visualization, but the site have more implementations, so fork the project and explore
## Getting Started
### Prerequisites
This project requires the following dependencies:
- [Docker compose](https://docs.docker.com/compose/install/)
### Installation
1. Clone the repo
```sh
git clone https://github.com/otaaaviio/library.git
```
2. Run the following command to build the project in first time
```sh
docker compose build --no-cache
```
3. Run the following command to start the project
```sh
docker compose up -d
```
Now you can access the project.
Available on:
library-vue | http://127.0.0.1:8080
library-vue | http://172.21.0.2:8080
## Development
### Project Structure
```
api/
├── assets/
├── components/
├── enums/
├── interfaces/
├── layouts/
├── locales/
├── pages/
├── plugins/
├── router/
├── stores/
|── styles/
app.vue
main.ts
```
This structure suggests a web application project that uses a modular architecture, with a clear separation between different parts of the code, such as components, pages, styles, and business logic (API). If you need more details or help with something specific from this project, feel free to make a ask issue!
## Built With
- [Vue.js](https://vuejs.org/) - The Progressive JavaScript Framework
- [Vuetify](https://vuetifyjs.com/en/) - Material Design Component Framework
- [Axios](https://axios-http.com/) - Promise based HTTP client for the browser and node.js
- [Vue i18n](https://kazupon.github.io/vue-i18n/) - Internationalization plugin for Vue.js
## Contributing
Fork the project and create a pull request.
## Conclusion
I hope you enjoyed the project, if you have any questions or suggestions, feel free to contact me. This project serves as a sample of my work with Vue.js and web application development, you can see the back-end repository [here](https://github.com/otaaaviio/library)
## Author
* **Otávio Gonçalves** - [linkedin](https://www.linkedin.com/in/otaaaviio/)