docs: Add CONTRIBUTING.md and update README.md features

Author: yash-pouranik

CONTRIBUTING.md

@@ -0,0 +1,89 @@
+# Contributing to urBackend
+
+Thank you for your interest in contributing to urBackend! We welcome contributions to help make this "Backend-as-a-Service" platform even better.
+
+Please take a moment to review this document in order to make the contribution process easy and effective for everyone involved.
+
+## 🚀 Getting Started
+
+### 1. Fork and Clone
+Fork the repository to your GitHub account and then clone it locally:
+
+```bash
+git clone https://github.com/YOUR_USERNAME/urBackend.git
+cd urBackend
+```
+
+### 2. Project Structure
+The repository is organized into two main directories:
+- **`backend/`**: Node.js & Express application handling the API, database, and authentication.
+- **`frontend/`**: React.js (Vite) application for the user dashboard.
+
+### 3. Setup and Installation
+
+#### Backend
+1. Navigate to the backend directory: `cd backend`
+2. Install dependencies: `npm install`
+3. Create a `.env` file (refer to `README.md` for required variables).
+4. Start the server:
+   ```bash
+   npm start
+   ```
+
+#### Frontend
+1. Navigate to the frontend directory: `cd frontend`
+2. Install dependencies: `npm install`
+3. Start the development server:
+   ```bash
+   npm run dev
+   ```
+
+## 🛠️ Development Workflow
+
+1. **Create a Branch**: Always create a new branch for your work. Use descriptive names like `feature/new-login-ui` or `fix/database-connection`.
+   ```bash
+   git checkout -b feature/your-feature-name
+   ```
+
+2. **Make Changes**: Implement your feature or fix. 
+
+3. **Test Your Changes**:
+   - **Backend**: Run tests using Jest.
+     ```bash
+     cd backend
+     npm test
+     ```
+   - **Frontend**: Ensure there are no linting errors.
+     ```bash
+     cd frontend
+     npm run lint
+     ```
+
+4. **Commit**: Use clear and concise commit messages.
+   ```bash
+   git commit -m "Add feature X"
+   ```
+
+5. **Push**: Push your branch to your forked repository.
+   ```bash
+   git push origin feature/your-feature-name
+   ```
+
+## 📬 Submitting a Pull Request (PR)
+
+1. Go to the original repository and click "Compare & pull request".
+2. Provide a clear title and description of your changes.
+3. Link any related issues (e.g., "Fixes #123").
+4. Wait for review and address any feedback.
+
+## 🐛 Reporting Bugs & Feature Requests
+
+- **Bugs**: If you find a bug, please create an issue describing the problem, steps to reproduce, and expected behavior.
+- **Features**: If you have an idea for a new feature, feel free to open an issue to discuss it before starting implementation.
+
+## 🤝 Code of Conduct
+
+Please be respectful and considerate of others. We aim to create a welcoming and inclusive environment for all contributors.
+
+---
+Happy Coding! 🚀

README.md

@@ -35,59 +35,6 @@ Stop writing boilerplate. Get an instant Database, Authentication, and Storage A
 - Multer (File Handling)
 - Supabase (Cloud Storage)
 
-## 🚀 Getting Started
-
-Follow these instructions to set up the project locally.
-
-### Prerequisites
-- Node.js (v18+)
-- MongoDB Atlas Connection URL
-- Supabase Account (for Storage)
-
-### 1. Backend Setup
-
-```bash
-cd backend
-npm install
-```
-
-Create a `.env` file in the `backend` folder:
-
-```env
-PORT=1234
-MONGO_URL=your_mongodb_connection_string
-JWT_SECRET=your_super_secret_key
-SUPABASE_URL=your_supabase_url
-SUPABASE_KEY=your_supabase_anon_key
-```
-
-Start the server:
-
-```bash
-npm start
-# Server will run on https://api.urbackend.bitbros.in
-```
-
-### 2. Frontend Setup
-
-```bash
-cd frontend
-npm install
-```
-
-Update `frontend/src/config.js` (if necessary):
-
-```javascript
-export const API_URL = 'https://api.urbackend.bitbros.in';
-```
-
-Start the client:
-
-```bash
-npm run dev
-# App will run on http://localhost:5173
-```
-
 ## 📖 API Usage Guide
 
 Once your project is created in the dashboard, use your **Public API Key** to make requests.
@@ -243,11 +190,7 @@ await fetch('https://api.urbackend.bitbros.in/api/storage/file', {
 
 ## 🤝 Contributing
 
-1. Fork the Repository
-2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
-3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
-4. Push to the Branch (`git push origin feature/AmazingFeature`)
-5. Open a Pull Request
+We welcome contributions! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for details on how to get started, development workflow, and our code of conduct.
 
 ---