Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
khemssharma committed Oct 13, 2024
2 parents 45211f5 + 2b2f5ce commit d876102
Showing 1 changed file with 67 additions and 0 deletions.
67 changes: 67 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
Make sure you have the following installed on your machine:

- [Git](https://git-scm.com/)
- [Node.js](https://nodejs.org/en)
- [npm](https://www.npmjs.com/) (Node Package Manager)

**Cloning the Repository**

```bash
git clone https://github.com/kc-sharma/StudyNotion.git
cd StudyNotion
```

**Installation**

Install the project dependencies using npm:

```bash
npm install
```

**Set Up Environment Variables**

Create a new file named `.env` in the root of your project and add the following content:

```env
REACT_APP_BASE_URL = http://localhost:4000/api/v1
REACT_APP_GOOGLE_CLIENT_ID = YOUR_OAUTH_CREDENTIALS
REACT_APP_RAZORPAY_KEY = YOUR_RAZORPAY_CREDENTIALS
```

Also Create a new file named `.env` in the server folder of your project and add the following content:

```env
MAIL_HOST = smtp.gmail.com
MAIL_USER =
MAIL_PASS =
GOOGLE_CLIENT_ID = YOUR_OAUTH_CREDENTIALS
JWT_SECRET =
FOLDER_NAME =
RAZORPAY_KEY = YOUR_RAZORPAY_CREDENTIALS
RAZORPAY_SECRET =
CLOUD_NAME =
API_KEY =
API_SECRET =
MONGODB_URL =
PORT = 4000
NODE_VERSION = 18.17.1
CLIENT = http://localhost:3000
```

Replace the placeholder values with your actual Google OAuth, Gmail SMTP, Razorpay, MongoDB and JWT credentials. You can obtain these credentials by signing up on the [Google Cloud Console](https://cloud.google.com/), [Razorpay](https://razorpay.com), [MongoDB](https://mongodb.com) and [JWT](https://jwt.io)

**Running the Project**

```bash
npm run dev
```

Open [http://localhost:3000](http://localhost:3000) in your browser to view the project.

0 comments on commit d876102

Please sign in to comment.