Skip to content

rupnil-codes/codepedia

Repository files navigation

Codepedia

Override.exe

React.JS %5E19.2.4 GNU AGPL 3.0 Hackatime Badge Commit Activity Commit History

An encyclopedia of Programming Language.


Overview

Codepedia is an open-source, interactive encyclopedia designed for developers, students, and tech enthusiasts. Built with React-TS, it includes languages like Python and JavaScript to systems languages like Zig and Bash.


Backstory

I have taken a lot of inspiration from Keyboard1000n17's OSPEDIA. I started this proj 2months ago and completing ts just now lol!


Requirements

  • A modern browser with JS support,
  • A keyboard and a mouse,
  • Curiosity and sheer will, &
  • Basic problem-solving skills

Usage: Quick Start

Pre-hosted

An instance of the ReactTS app is hosted by me through Github Pages. You can easily access this hosted instance at codepedia.rupnil.codes! The hosted website is compatible with most modern browsers and thus most OS.

Building from source

Idk why you would want to build from the source when i have it deployed, but here u go anyways.

Before building make sure you have the following installed:

  • Node.js (Version 20 or higher)
  • npm (comes with Node.js) or similar, e.g. pnpm/yarn/etc.

1. Clone the repository

git clone https://github.com/rupnil-codes/codepedia.git
cd codepedia

2. Install Dependencies

npm install
npm update

3. Run Development Server

npm run dev

or

npx vite

4. Build for Production

npm run build

Then the final compiled webapp will be in the dist/ directory.


Features:

I've tried adding as many features as I could, here are some:

  • 30 Languages; A vast collection of languages from Bash to Zig.
  • Curated Links; link directly to the best docs.
  • Good visuals

Unfinished Features:

  • Search bar

Project Status

Version: v0.4.1-beta

Latest Release Version: v0.4-beta

Status: Actively developing as of now


Contributors

There are several well-wishers and playtesters who have helped me improve the app, either by playtesting or providing valuable feedback. I've listed them in no particular order.

  1. @Flux3tor,
  2. @Snxhit_,
  3. @Keyboard1000n17,
  4. @SeradedStripes, &
  5. @stunt

If i forgot to mention anyone, pls DM me on slack!


Made with 💖 by @rupnil.codes

If you found this project interesting, consider giving it a star :D

Report a Bug or Suggest a new Feature

About

An Encyclopedia of Programming Languages

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors