StorageR

Lightweight Cloud based storage and service management application based on React, Typescript and Tailwind.

Getting started 🚀

Preparing Cloud Environment ☁️

In order to have StorageR application functional we need to create a .env file based on our available .env.template

We need to create a Google Firebase Project in Google Console for this here: https://console.firebase.google.com/project/

After you have the access to Firebase Dashboard use the following steps:

• Create a Web App
  • Open Project settings
  • Under Your apps section click the Add app button and click to the third Web App button
  • On the next page Add a nickname to your app and click to Register app button and then Continue to console
  • Now in the Your apps section you can see all of the details you need to put in your .env file
• Setup collection Rules
  • Open Firestore Database in Build Menu
  • Open Rules tab, and update it in order to have proper connection with your app
    • DEV: You can use the following in DEV environments: allow read, write: if request.time < timestamp.date(2050, 11, 30);

Environment Setup

1. Install dependencies

npm install

2. Create a .env file based on .env.template

cp .env.example .env

3. Setup environment variables based on your GCP Firebase cloud setup

VITE_FIREBASE_APIKEY=your_api_key
VITE_FIREBASE_AUTH_DOMAIN=your-auth-domain
VITE_FIREBASE_PROJECT_ID=your-project_id
VITE_FIREBASE_STORAGE_BUCKET=your_storage_bucket
VITE_FIREBASE_MESSAGE_SENDER_ID=your-message-sender-id
VITE_FIREBASE_APP_ID=your-firebase-id
VITE_FIREBASE_MEASUREMENT_ID=your-measurement-id

VITE_FIREBASE_DB_SHOPS=shops
VITE_FIREBASE_DB_ITEMS=items
VITE_FIREBASE_DB_PARTS=parts
VITE_FIREBASE_DB_SERVICES=services
VITE_FIREBASE_DB_COMPLETIONS=completions
VITE_FIREBASE_DB_SETTINGS=settings
VITE_FIREBASE_DB_USERS=users

VITE_BASENAME=/

4. Start the development server 🔥

npm dev

It will automatically open http://localhost:5173 with your primary browser.

5. Build when you are ready

npm build

Contribute

There are many ways to contribute to StorageR.

• Submit bugs and help us verify fixes as they are checked in.
• Review the source code changes.
• Contribute bug fixes.