Open Source Projects Showcase

Discover and explore a curated collection of open source projects from GitHub and other platforms.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Features
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Contributing
5. License
6. Contact
7. Acknowledgments

About The Project

Open Source Projects Showcase is a web application that curates and displays a collection of open source projects from GitHub and other platforms. It provides a visually appealing, accessible, and responsive interface for users to discover, explore, and contribute to open source projects.

(back to top)

Features

• Curated list of open source projects from GitHub (expandable to GitLab, Gitee, Bitbucket)
• Dynamic project metadata fetching (stars, forks, topics, etc.) via GitHub API
• Responsive and accessible UI with modern design
• Easy to add new projects via JSON configuration
• Cloudflare Workers deployment for fast, global delivery
• SEO and social sharing optimized

(back to top)

Built With

• Cloudflare Workers
• node-fetch
• HTML5
• CSS3
• JavaScript (ES6+)

(back to top)

Getting Started

To get a local copy up and running, follow these steps.

Prerequisites

• Node.js (v16+ recommended)
• npm
• Cloudflare Wrangler CLI

Install npm if you do not have it:

npm install npm@latest -g

Install Wrangler globally:

npm install -g wrangler

Installation

1. Clone the repository

   git clone https://github.com/LoveDoLove/open-source-projects.git
   cd open-source-projects

2. Install dependencies

   npm install

3. (Optional) Update project metadata from GitHub

   node scripts/fetchRepoMetadata.js

4. Start the development server

   npm run dev

5. Deploy to Cloudflare Workers

   npm run deploy

(back to top)

Usage

Once running, visit the site in your browser. Browse the list of open source projects, view project details, and follow links to GitHub repositories. To add your own project, edit data/projects.json and run the metadata fetch script.

For more usage examples, refer to the Documentation.

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

Top contributors:

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

LoveDoLove - @LoveDoLove

Project Link: https://github.com/LoveDoLove/open-source-projects

(back to top)

Acknowledgments

• Cloudflare Workers
• node-fetch
• Best-README-Template

(back to top)