cejimenez0123 / pb-web

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contact
6. Acknowledgments

About The Project

[Plumbum](https://plumbum.app/about)

This project is part of finding a solution for my needs of having a resource manager for my writing and inpiration. Inspired by the enviroment of writers' workshops. The app uses pages,books, and libraries, as a metaphor of instances of work, projects, and community for projects.

It uses React and Material UI for UI, Redux Toolkit for added state mangagement, ajdnAlgolia for search. Also, Firebase and it's Firestore,Auth, and Hosting libraries.

Built With

• React.js
• Redux Toolkit
• Algolia
• Firebase/Firestore
• MaterialUI

Getting Started

Prerequisites

I used VSCode as my IDE. You will need your own IDE.

• VSCode

Installation

1. Get your API Keys at for Firebase to open a new project. As well, Algolia

2. Clone the repo

   git clone https://github.com/cejimenez0123/pb-web.git

3. Install NPM packages

    npm install

4. Enter your API in .env

   VITE_FIREBASE_API_KEY="xxxxxxxxxxxxxxxxxxxxxxxxxxx"
   VITE_AUTH_DOMAIN="xxxxxxxxxxxxxx.firebaseapp.com"
   VITE_DATABASE_URL="https://xxxxxxxxxxxxxxxx.firebaseio.com"
   VITE_PROJECT_ID = "xxxxxxxx-12345"
   VITE_STORAGE_BUCKET = "xxxxxxx-12345.appspot.com"
   VITE_MESSAGING_SENDER_ID = "xxxxxxxxxxx"
   VITE_APP_ID="xxxxxxxxxxxxxxxxxxxxxxx"
   VITE_MEASUREMENT_ID = "G-XXXXXXXXXXXX"
   VITE_ALGOLIA_APP_ID = "XXXXXXXXXXX"
   VITE_ALGOLIA_API_KEY = "xxxxxxxxxxxxxxxxxxxxxxxxx"

Contact

Christian Jimenez instagram:@plumbumapp @Plumbum 2023 Project Link: https://https://github.com/cejimenez0123/pb-web