ℹ️ About • ✨ Install • 🔒 Backend • ⚒ General-App-Features • 📋 Backend-Features • 🔑 Frontend • 📋 Frontend-Features • 🌚 Actions
This project consists of a web made with React.js, Nestjs and Typescript, using the client-server architecture. The main idea of this website is to store the multimedia game content consumed (movies and series in future).
- Branching strategy using git-flow
- Commit messages are made using git-cz, to make them prettier
- Technologies and tools:
-
Install Node:
- Click this link to download Node.
-
Install Docker:
- Click this link to download Docker.
-
Clone this repository:
git clone https://github.com/plexus-tech/book-swap-hub.git. -
Run de docker-compose :
- Go to the docker folder to run the docker-compose.
- Ejecuta el Docker-compose con:
docker-compose up
-
Run the frontend:
- Go to Backend folder to run the backend:
cd backend. - 🚀Run the app with:
npm run start:dev
- Go to Backend folder to run the backend:
-
Run the backend:
- Go to Frontend folder to run the Frontend:
cd frontend. - 🚀Run the app with:
npm run start
- Go to Frontend folder to run the Frontend:
- Built using SOLID principles.
- Built using HEXAGONAL ARCHITECTURE with the following layers api_rest, infrastructure, application, domain.
- Built using Typescript.
- Built using Nestjs: A Node.js framework for building efficient, reliable and scalable server-side applications on top of TypeScript & JavaScript (ES6, ES7, ES8).
- Built using TypeOrm: Is a ORM for TypeScript and JavaScript. Supports MySQL, PostgreSQL, MariaDB, SQLite, MS SQL Server, Oracle, SAP Hana, WebSQL databases. Works in NodeJS, Browser, Ionic, Cordova and Electron platforms.
- JWT authentication and role based authorization.
- OpenAPI definition
- Linting with ESLint
- Formatting with Prettier
- Containerised using Docker and Docker Compose
- GitHub Actions
- Built using React: Is an open source Javascript library designed to create user interfaces to facilitate the development of single page applications.
(example it means that it is in process)
-
You can register users.
-
You can login users.
-
You can search users. -
You can follow users. -
You can update your user.
-
You can delete your users.
-
You can search games.
-
You can rate games.
-
You can add games to favorites.
-
You delete your games.
-
You can store your information about the game(state, description ...).