Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/luisauter/bookend

Bookend is a web application for free books of science 📚️
https://github.com/luisauter/bookend

book book-api book-app bookend bookend-pwa bookends books graphql mongodb next-auth nextjs pwa react tailwindcss typescript

Last synced: about 12 hours ago
JSON representation

Bookend is a web application for free books of science 📚️

Host: GitHub
URL: https://github.com/luisauter/bookend
Owner: LuiSauter
License: mit
Created: 2021-12-06T04:15:01.000Z (almost 3 years ago)
Default Branch: master
Last Pushed: 2023-11-05T19:58:38.000Z (about 1 year ago)
Last Synced: 2023-11-05T20:32:23.348Z (about 1 year ago)
Topics: book, book-api, book-app, bookend, bookend-pwa, bookends, books, graphql, mongodb, next-auth, nextjs, pwa, react, tailwindcss, typescript
Language: TypeScript
Homepage: https://bookendd.vercel.app
Size: 3.06 MB
Stars: 8
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md

Awesome Lists containing this project

README

        







  

    

  

  Bookend

  

[![Contributors][contributors-shield]][contributors-url]

[![Forks][forks-shield]][forks-url]

[![Stargazers][stars-shield]][stars-url]

[![Issues][issues-shield]][issues-url]

[![MIT License][license-shield]][license-url]

[![LinkedIn][linkedin-shield]][linkedin-url]

  


Bookend is a web application to share books and it was thanks to the idea that arose when I was looking to carry out fullstack development practices


    


    


    View Demo

    ·

    Report Bug

  



## About The Project

![Product Name Screen Shot][product-screenshot]

![Books ranking of bookend][ranking-books-screenshot]

Bookend is a web application to share books and it was thanks to the idea that arose when I was looking to carry out fullstack development practices, and I asked myself, can I develop a social network? thanks to this I have learned a lot!

Here's why:

* A project that helps to find books

* Sign up for free and search for your favorite book.

* Ah! and you can also follow people and save your favorite books :smile:

(back to top)


### Built With

* [Next.js](https://nextjs.org/)

* [React.js](https://reactjs.org/)

* [TypeScript](https://www.typescriptlang.org/)

* [GraphQL](https://graphql.org/)

* [Apollo](https://www.apollographql.com/)

* [Mongoose.js](https://mongoosejs.com/)

* [MongoDB](https://www.mongodb.com/)

* [Tailwindcss](https://tailwindcss.com/)

  (Extension) `Tailwind CSS IntelliSense` enhances the Tailwind development experience by providing Visual Studio Code users with advanced features such as autocomplete, syntax highlighting, and linting

(back to top)


## Getting Started

This is an example of how to configure `.env.local` to have a working local copy.



### Prerequisites

This is an example of how to list things you need to use the software and how to install them.

* .env.local

  ```sh

  ## NEXTAUTH_URL=https://example.com production

  SECRET=https://generate-secret.now.sh/32

  JWT_SECRET=

  

  ## Create cluster in mongodb free tier

  ## https://docs.atlas.mongodb.com/tutorial/create-new-cluster/#select-the-cluster-tier

  MONGODB_URI=mongodb+srv://:@?retryWrites=true&w=majority

  ## EXAMPLE: https://dev.to/veritechie/deploy-node-express-mongo-atlas-con-fetch-de-react-en-heroku-mern-app-3ien

  

  ## Create credentials google client and google client secret Oauth

  ## https://developers.google.com/identity/protocols/oauth2

  ## homepage URL* = http://localhost:3000

  ## Authorization callback URL* = http://localhost:3000/api/auth/callback/google

  GOOGLE_CLIENT=

  GOOGLE_CLIENT_SECRET=

  

  ## Create credentials github

  ## https://github.com/settings/developers

  ## homepage URL* = http://localhost:3000

  ## Authorization callback URL* = http://localhost:3000/api/auth/callback/github

  GITHUB_CLIENT=

  GITHUB_CLIENT_SECRET=

  

  ## Uri development

  URI_1=http://localhost:3000

  ## path uri for API development

  PATH_URI=/api/graphql

  ```

### Installation

_Use the package manager `yarn` to install the dependencies._

1. Clone the repo

   ```sh

   git clone https://github.com/LuiSauter/bookend.git

   ```

2. Install Yarn packages

   ```sh

   ## Install yarn global

   npm install --global yarn

   

   yarn install

   ```

3. Meet the prerequisites `.env.local`

    
(go back to prerequisites)


(back to top)


[contributors-shield]: https://img.shields.io/github/contributors/LuiSauter/bookend.svg?style=for-the-badge

[contributors-url]: https://github.com/LuiSauter/bookend/

[forks-shield]: https://img.shields.io/github/forks/LuiSauter/bookend.svg?style=for-the-badge

[forks-url]: https://github.com/LuiSauter/bookend/network/members

[stars-shield]: https://img.shields.io/github/stars/LuiSauter/bookend.svg?style=for-the-badge

[stars-url]: https://github.com/LuiSauter/bookend/stargazers

[issues-shield]: https://img.shields.io/github/issues/LuiSauter/bookend.svg?style=for-the-badge

[issues-url]: https://github.com/LuiSauter/bookend/issues

[license-shield]: https://img.shields.io/github/license/LuiSauter/bookend.svg?style=for-the-badge

[license-url]: https://github.com/LuiSauter/bookend/blob/main/LICENSE

[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555

[linkedin-url]: https://linkedin.com/in/luis-gabriel-janco/

[product-screenshot]: public/images/bookendd.vercel.app.webp

[ranking-books-screenshot]: public/images/bookendd.vercel.app_books.webp

## Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

I accept suggestions.