Giter Site home page Giter Site logo

jofiel-nguyen / booksearchwren Goto Github PK

View Code? Open in Web Editor NEW
0.0 1.0 0.0 16.01 MB

A full-stack web application that allows users to search for books, save their favorite books, and view their saved book list. This README will guide you through the installation, usage, deployment, and contribution process for this project.

Home Page: https://jofiel-nguyen.github.io/BookSearchWren/

License: MIT License

HTML 5.88% JavaScript 93.63% CSS 0.50%
heroku-deployment herokuapp html-css-javascript reactjs

booksearchwren's Introduction

Book Search Engine App

Welcome to the Book Search Engine App, a full-stack web application that allows users to search for books, save their favorite books, and view their saved book list. This README will guide you through the installation, usage, deployment, and contribution process for this project.

Technologies Used

  • MongoDB
  • Express.js
  • React
  • Node.js
  • GraphQL
  • Apollo Server
  • Apollo Client
  • React Router
  • JSON Web Token (JWT) for authentication
  • bcrypt for password hashing

Installation

To run the Book Search Engine on your local machine, you need to have Node.js and MongoDB installed. Follow these steps:

  1. Clone the repository:

    git clone https://github.com/your-username/book-search-engine.git
  2. Change into the project directory:

    cd book-search-engine
  3. Install the dependencies:

    npm install
  4. Create a .env file in the root directory and add your MongoDB connection string and JWT secret key:

    MONGODB_URI=your-mongodb-connection-string
    SECRET_KEY=your-secret-key-for-jwt

Usage

To start the development server, run the following command:

npm start

The application will be available at http://localhost:3000.

Deployment

The application can be deployed to Heroku using the following steps:

  1. Create a new Heroku app and configure the environment variables for MongoDB connection and JWT secret key.

  2. Push the code to the Heroku app's repository:

    git push heroku main

Heroku will automatically build and deploy the application.

Contributing

Contributions to the Book Search Engine project are welcome! If you find any issues or have suggestions for improvements, feel free to open a pull request.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Contact

If you have any questions or want to collaborate on this project, you can reach me at my email.

Deploy

Demo Demo

© 2023 edX Boot Camps LLC. Confidential and Proprietary. All Rights Reserved.

booksearchwren's People

Contributors

jofiel-nguyen avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.