Skip to content

Latest commit

 

History

History
109 lines (81 loc) · 3.41 KB

README.md

File metadata and controls

109 lines (81 loc) · 3.41 KB
Raw

🖥️ Ten Thousand Hours Project

A platform designed to help you sharpen your Data Structures and Algorithms (DSA) skills. Practice DSA questions, earn points, and level up to unlock proficiency certificates! 🏆 Plus, get assistance from our chatbot, Partner, who will help you with DSA and tech-related questions. Preview

📂 Project Structure

The repository is organized into two main directories:

  • server/: Backend code built with Node.js, Express, and MongoDB.
  • tenthousandhours_project/: Frontend code crafted using React.

✨ Features

  • 📝 Practice a wide variety of DSA questions.
  • 🏆 Earn points as you solve problems and get closer to proficiency certificates.
  • 🤖 Chatbot assistance for real-time help with DSA and tech queries.
  • 🎯 Integrated frontend and backend for a smooth user experience.

🛠️ Technologies Used

Backend

  • Node.js: JavaScript runtime for server-side development.
  • Express: Fast and minimalist web framework for Node.js.
  • MongoDB: NoSQL database for data storage.

Frontend

  • React: JavaScript library for building user interfaces.

🚀 Getting Started

Follow these steps to set up the project locally:

Prerequisites

  • Node.js installed on your machine.
  • MongoDB installed and running locally or in the cloud.

Installation

  1. Clone the repository: 
    git clone https://github.com/your-username/your-repo-name.git
cd your-repo-name
  2. Set up the Backend:
  • Navigate to the server directory: 
    cd server
  • Create a .env file in the server directory and add your MongoDB connection string and other environment variables: 
    MONGODB_URI=your-mongodb-connection-string
PORT=5000
JWT_SECRET=your-jwt-secret-key
  • navigate to server 
    cd dsa-practice-site
npm i
cd server
  • start server nodemon index.js
  • The server should now be running on http://localhost:5000.
  1. Set up the Frontend:
  • Navigate to the frontend directory: 
    cd dsa-practice-site
cd tenthousandhours_project
  • Start the React app: 
    npm start
  • The React app should now be running on http://localhost:3000.

🤝 Contributing

We welcome contributions! Here's how you can get involved:

Steps to Contribute

  1. Fork the repository
  2. Clone your forked repo to your local machine: 
    git clone https://github.com/your-username/your-forked-repo-name.git
  3. Create a new branch for your feature: 
    git checkout -b feature-name
  4. Make your changes and commit them with clear messages: 
    git commit -m "Add a brief message about your feature"
  5. Push your branch to GitHub: 
    git push origin feature-name
  6. Create a Pull Request on the main repository with a description of your changes.

Contribution Guidelines

  • 🔧 Follow coding standards and write clear comments.
  • ✅ Test your changes thoroughly before making a pull request.
  • 💬 Communicate politely and respect other developers' work.

🌐 Follow Me

Stay connected and follow my journey:

💬 Feedback

If you have any feedback or suggestions, feel free to reach out by opening an issue or contacting me on social media. Your input is highly appreciated!