Skip to content

docs: enhance developer guide with linting rules and env setup (#379) #467

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
MsParadox wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: enhance developer guide with linting rules and env setup (#379) #467

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,15 @@ npm run dev
```
The application will be running locally at `http://localhost:5173`.

### 6. Code Quality & Linting
RankerHub maintains strict code quality and formatting rules. Before you commit any changes or submit a Pull Request, you **must** run the custom linting script.

This script will automatically scan your files, fix formatting issues, and ensure Tailwind classes are properly ordered:
```bash
node fix_lint.mjs
```
Note: If the script detects errors it cannot auto-fix, please resolve them manually before pushing.

---

## Firebase Setup
Expand Down
25 changes: 17 additions & 8 deletions DEVELOPER_GUIDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,9 @@ Install the required dependencies:

Bash
npm install

🔥 Step 2: Firebase Project Provisioning

To prevent testing against the production database, create your own Firebase project for local development.

Create a Firebase Project
Expand Down Expand Up @@ -66,17 +68,24 @@ Click Add App → Web App.
Copy the Firebase configuration values.

🔑 Step 3: Environment Variables
Create a .env file in the project root and add your Firebase configuration:

Code snippet
The project contains a `.env.example` file which outlines all the required keys.

1. Copy the example file to create your own local environment file:
```bash
cp .env.example .env

2. Open your new .env file and replace the placeholder values with the configuration from your newly created Firebase project:

VITE_FIREBASE_API_KEY=your_api_key_here
VITE_FIREBASE_AUTH_DOMAIN=your_project_id.firebaseapp.com
VITE_FIREBASE_PROJECT_ID=your_project_id
VITE_FIREBASE_STORAGE_BUCKET=your_project_id.firebasestorage.app
VITE_FIREBASE_MESSAGING_SENDER_ID=your_sender_id
VITE_FIREBASE_APP_ID=your_app_id
VITE_FIREBASE_MEASUREMENT_ID=your_measurement_id
⚠️ Important: Never commit your .env file. It is already included in .gitignore.

⚠️ Important: Never commit your .env file. It is already included in our .gitignore to prevent sensitive key leaks.

📦 Step 4: Firebase CLI and Database Setup
Deploy the required Firestore Security Rules and Indexes so leaderboard queries function correctly.
Expand Down Expand Up @@ -125,12 +134,12 @@ You can now log in using GitHub authentication. Your first developer profile wil
Create a Feature Branch
Bash
git checkout -b feature/your-feature-name
Develop and Test
Make your changes.

Test everything locally.

Verify functionality using the Firestore emulator.
Develop and Test
- Make your changes.
- Test everything locally.
- Verify functionality using the Firestore emulator.
- Run `node fix_lint.mjs` to ensure your code meets the project's formatting standards.

Commit Changes
Use the project's commit conventions:
Expand Down
Loading