Skip to content

Commit

Permalink
Merge pull request #184 from Abhimoy-Mukherjee/staging
Browse files Browse the repository at this point in the history
  • Loading branch information
SkySingh04 authored Jan 17, 2025
2 parents 150b7cb + 51a5c87 commit 1b8c0c2
Showing 1 changed file with 21 additions and 24 deletions.
45 changes: 21 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,36 +32,33 @@ pnpm install
bun install
```

### **3. Set Up Firebase Configuration**
To connect the project to Firebase, you need a `.env.local` file in the root directory.

#### Create the `.env.local` file:
```plaintext
REACT_APP_FIREBASE_API_KEY=xxx
REACT_APP_FIREBASE_AUTH_DOMAIN=xxx
REACT_APP_FIREBASE_PROJECT_ID=xxx
REACT_APP_FIREBASE_STORAGE_BUCKET=xxx
REACT_APP_FIREBASE_MESSAGING_SENDER_ID=xxx
REACT_APP_FIREBASE_APP_ID=xxx
```
### **3. Install Infisical CLI**
Follow the instructions in the [Infisical CLI documentation](https://infisical.com/docs/cli/overview)
to install the CLI on your machine.


**Note**: Replace the `xxx` values with the Firebase configuration keys.
Contact one of the maintainers to obtain the Firebase config details.
The application will be accessible at [http://localhost:3000](http://localhost:3000).

### **4. Run the Development Server**
Start the development server with one of the following commands:
### **4. Login and Initialize Infisical**
1. Navigate to the repository in your terminal.
2. Run the following command to log in:
```bash
npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev
infisical login
```
**Note** : contact one of the maintainers to obtain the infisical credentials.

The application will be accessible at [http://localhost:3000](http://localhost:3000).
### **5. Use infisical run -- as a Prefix for Commands**
When running commands, prepend them with `infisical run --`.

For example, instead of running:
```bash
npm run dev
```
Use:
```bash
infisical run -- npm run dev
```
#### Tip: To simplify this process, you can create aliases for commonly used commands.**
---

## **Contributing**
Expand Down

0 comments on commit 1b8c0c2

Please sign in to comment.