Skip to content

Latest commit

 

History

History
67 lines (45 loc) · 1.33 KB

README.md

File metadata and controls

67 lines (45 loc) · 1.33 KB

Open Source Path finder

Open Source Path finder is a web application that allows users to search for projects and Discord servers based on various criteria.

Features

  • Search for projects by name, tags, difficulty, and language.
  • Display a list of Discord servers related to coding and programming.
  • Coming soon page for future features.

Technologies Used

  • React
  • Next.js
  • Tailwind CSS
  • Shadcn
  • TypeScript

Getting Started

Prerequisites

  • Node.js
  • npm or yarn

Installation

  1. Clone the repository:

    git clone https://github.com/realvishalrana/Open-Source-Path-finder.git
cd Open-Source-Path-finder

  2. Install dependencies:

    npm install
# or
yarn install

  3. Create a .env.local file in the root directory and add the following environment variables:

    NEXT_PUBLIC_GITHUB_CLIENT_ID=your_github_client_id
NEXT_PUBLIC_GITHUB_TOKEN=your_github_token
NEXT_PUBLIC_DISCORD_BOT_TOKEN=your_discord_bot_token

  4. Run the development server:

    npm run dev
# or
yarn dev

  5. Open http://localhost:3000 with your browser to see the result.

Contributing

Contributions are welcome! Please open an issue or submit a pull request for any changes.

License

This project is licensed under the MIT License.