Skip to content

Commit

Permalink
readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
farooqpk committed Sep 29, 2024
1 parent 3aad642 commit d0bcdd4
Showing 1 changed file with 21 additions and 20 deletions.
41 changes: 21 additions & 20 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@

# Talker Backend

This is the backend server for a real-time chat application built with Node.js and Socket.IO.
Expand All @@ -13,41 +12,43 @@ This is the backend server for a real-time chat application built with Node.js a

1. Clone the repository:

git clone https://github.com/farooqpk/talker-backEnd.git
git clone https://github.com/farooqpk/talker-backEnd.git


2. Navigate to the project directory:

cd talker-backEnd
cd talker-backEnd


3. Install dependencies:

npm install
npm install


4. Create a `.env` file in the root directory and add the following environment variables:

PORT= your_port_number
DATABASE_URL= your_mongodb_url
ACCESS_TOKEN_SECRET= your_access_token_secret
REFRESH_TOKEN_SECRET= your_refresh_token_secret
REDIS_URL= your_redis_url
R2_ACCOUNT_ID= your_cloudflare_r2_account_id
R2_ACCESS_KEY= your_cloudflare_r2_access_key
R2_SECRET_KEY= your_cloudflare_r2_secret_key
R2_BUCKET_NAME= your_cloudflare_r2_bucket_name
NODE_ENV='development'
GEMINI_API_KEY= your_gemini_api_key
CERTBOT_EMAIL= your_certbot_email
ACCESS_TOKEN_EXPIRY=2
REFRESH_TOKEN_EXPIRY=30
PORT=your_port_number
DATABASE_URL=your_mongodb_url
ACCESS_TOKEN_SECRET=your_access_token_secret
REFRESH_TOKEN_SECRET=your_refresh_token_secret
REDIS_URL=your_redis_url
R2_ACCOUNT_ID=your_cloudflare_r2_account_id
R2_ACCESS_KEY=your_cloudflare_r2_access_key
R2_SECRET_KEY=your_cloudflare_r2_secret_key
R2_BUCKET_NAME=your_cloudflare_r2_bucket_name
NODE_ENV='development'
GEMINI_API_KEY=your_gemini_api_key
CERTBOT_EMAIL=your_certbot_email
ACCESS_TOKEN_EXPIRY=2
REFRESH_TOKEN_EXPIRY=30


## Usage

1. Start the server:

npm start
npm start


2. The server will be running on `http://localhost:8000` (or the port you specified in the `.env` file).

Expand All @@ -61,6 +62,6 @@ REFRESH_TOKEN_EXPIRY=30

## Contact

Your Name - https://linkedin.com/in/ummarfarooq-pk
Linkedin - https://linkedin.com/in/ummarfarooq-pk

Live Link: [https://talker.fun](https://talker.fun)

0 comments on commit d0bcdd4

Please sign in to comment.