LuiSauter / bookend

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

Bookend

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

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 😄

(back to top)

Built With

• Next.js
• React.js
• TypeScript
• GraphQL
• Apollo
• Mongoose.js
• MongoDB
• Tailwindcss (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

  ## NEXTAUTH_URL=https://example.com production
  SECRET=https://generate-secret.now.sh/32
  JWT_SECRET=<secrect>
  
  ## Create cluster in mongodb free tier
  ## https://docs.atlas.mongodb.com/tutorial/create-new-cluster/#select-the-cluster-tier
  MONGODB_URI=mongodb+srv://<username>:<password>@<your-cluster-url>?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

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

2. Install Yarn packages

   ## Install yarn global
   npm install --global yarn
   
   yarn install

3. Meet the prerequisites .env.local

   (go back to prerequisites)

(back to top)

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.