Skip to content

AbdulRahman-04/GitHubBackend

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 

Repository files navigation

GitHub Backend Clone

This project is a backend clone of GitHub, allowing users to register, log in, and access private APIs using JWT authentication. Authenticated users can perform actions such as creating repositories, gists, and more.


🚀 Installation Guide

Follow these steps to set up the project on your local machine:

1️⃣ Clone the Repository

Open your terminal (Linux/VS Code) and run:

git clone <repository-url>

2️⃣ Install Dependencies

Navigate to the project folder and install the required Node.js packages:

npm install

3️⃣ Configure Environment Variables

  • Inside the config folder, set values for all required keys.
  • Refer to the default.json file inside the config folder for better understanding.

4️⃣ Install Nodemon (Optional, Recommended)

To enable automatic server restarts during development:

npm install -g nodemon

5️⃣ Start the Server

Run the following command to start the backend:

npm start

📩 Need Help?

If you're stuck or have any questions, feel free to reach out:

📧 [email protected]


Happy Coding! ✨🚀