https://github.com/codeday-labs-2021/bookworms

:book: :bug: bookworms is a CodeDay Labs project to create a web app to share your ideas of a book with others.
https://github.com/codeday-labs-2021/bookworms

golang javascript reactjs vercel

Last synced: 9 months ago
JSON representation

:book: :bug: bookworms is a CodeDay Labs project to create a web app to share your ideas of a book with others.

• Host: GitHub
• URL: https://github.com/codeday-labs-2021/bookworms
• Owner: codeday-labs-2021
• Archived: true
• Created: 2021-07-06T17:57:17.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2021-10-25T20:40:08.000Z (over 4 years ago)
• Last Synced: 2024-12-16T06:45:03.878Z (over 1 year ago)
• Topics: golang, javascript, reactjs, vercel
• Language: JavaScript
• Homepage: https://codeday-labs.github.io/bookworms/
• Size: 2.88 MB
• Stars: 1
• Watchers: 2
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          


  

    

  



Bookworms

=========

Bookworms is a CodeDay Labs project to create a web app to share your ideas of a book with others.

[![Deploy client to Github Pages](https://github.com/codeday-labs/bookworms/actions/workflows/client.yml/badge.svg?branch=main)](https://github.com/codeday-labs/bookworms/actions/workflows/client.yml)

[![Deploy server to Vercel](https://github.com/codeday-labs/bookworms/actions/workflows/server.yml/badge.svg?branch=main)](https://github.com/codeday-labs/bookworms/actions/workflows/server.yml)

## Installation

Check [client](./client) and [server](./server) for how to install them.

## Self-hosting

If you clone / fork this project and want to host it on your own, few configuration you need to do in advance.

### Github Secrets

Following secrets you need to add to your [Github Secrets](https://docs.github.com/en/actions/reference/encrypted-secrets) to make it work using Github Actions.

| Name | Description |

| ---- | ----------- |

| VERCEL_TOKEN | vercel token |

| VERCEL_PROJECT_ID | vercel project id |

| VERCEL_ORG_ID | vercel org id |

> For details, check here: https://github.com/marketplace/actions/vercel-action

### Vercel Environment Variables

In your linked Vercel project, following environment variable must be added:

| Name | Description |

| ---- | ----------- |

| MONGODB_URI | mongodb uri, ex: mongodb+srv://root:password@example.mongodb.net/bookworms?retryWrites=true&w=majority |

## Contributors

- [Dan Khanh (Aurora) V.](https://www.linkedin.com/in/aurora-vo/)

- [Jerome Wu](https://www.linkedin.com/in/wenchiehwu/)

- [Makuza Mugabo verite](https://www.linkedin.com/in/makuza-mugabo-verite-99369a184/)