Skip to content

This project have been developed with: Front = React, Typescript & Vite. Backend = Node.js, Mongoose, Typescript & MongoDB.

Notifications You must be signed in to change notification settings

Javiermartin12/Bookify

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 

Repository files navigation

Bookify

Bookify is a web application that allows you to browse, search and manage a collection of recommended books. The application offers functionalities to register new books, view book details, and maintain a user profile with secure authentication.

Content Table

  1. Features
  2. Technologies
  3. Installation
  4. Use
  5. Settings
  6. Contributions
  7. License

Features

  • Book Browsing: Browse through a collection of recommended books.
  • Book Search: Search for books by title, author or genre.
  • Book Registration: Add new books to the collection with details such as title, author, genre and synopsis.
  • User Profile: Secure authentication and profile management with Auth0.
  • Friendly Interface: Intuitive and easy-to-use design with Material-UI.

Technologies

  • Frontend:

    • React - Library for building user interfaces.

    • Material-UI - User interface components.

    • Axios - HTTP client to make requests.

    • Wouter - Lightweight router for React.

    • Backend:

    • Node.js - Runtime environment for server-side JavaScript.

    • Express - Framework for building web applications.

    • MongoDB - NoSQL database.

    • Auth0 - Authentication and authorization.

    Facility

    To run this application locally, follow these steps:

  1. Clone the Repository:
   git clone https://github.com/tu-usuario/recommended-book.git
  1. Install Dependencies:
  • Frontend:

cd frontend npm install

  • Backend:

cd backend npm install

  1. Configure Environment Variables:

REACT_APP_AUTH0_DOMAIN=tu-dominio.auth0.com REACT_APP_AUTH0_CLIENT_ID=tu-client-id REACT_APP_AUTH0_AUDIENCE=tu-audience VITE_CLOUDINARY_URL=https://api.cloudinary.com/v1_1/tu-cloud-name/image/upload VITE_UPLOAD_PRESET=tu-upload-preset

  1. Run the Application:
  • Frontend: cd frontend: npm run dev

  • Backend: cd backend: npm run dev

Use

Authentication:

  1. Log in using Auth0 to access the app's functionalities. Explore Books:

  2. Browse the main page to see a list of recommended books. Search Books:

  3. Use the search bar to find books by title, author, or genre. Add Books:

  4. Head to the book creation page to add new books to the collection. See Details:

  5. Click on a book to see its detailed information.

Configuration

To configure the application for production, ensure that the environment variables are correctly defined and that the backend is properly configured to handle requests in a production environment.

Contributions

Contributions are welcome. If you want to contribute to the project, follow these steps:

  1. Fork the Repository.

  2. Create a Branch for your Feature or Fix.

  3. Commit your Changes.

  4. Push the branch.

  5. Create a pull request.

License

This project does not have a license.

About

This project have been developed with: Front = React, Typescript & Vite. Backend = Node.js, Mongoose, Typescript & MongoDB.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages