Dev Encyclopedia;

devpedia.pages.dev | devpedia.dev

A simple project simplifies technical terms, concepts, jargon, and whatnot: Open-source and ad-free. It is fueled by contributions and donations (and coffee, of course).

This project is launched but much space for improvement is left. Help me build this project by contributing to this repository

---

Tech Stack

---

Quick Links

License | Sponsoring | How to Contribute | Notable Contributors | Installation and Deployment

---

Installation and Deployment

Install all the requirements with npm install after forking and cloning the repository:

  npm install

To deploy this project in a local environment, run the following:

  npm run dev

To build your site for deployment, run the following. By default, this will generate static files and place them in a dist/ directory. If SSR is enabled, this will generate the necessary server files to serve your site.

  npm run build

The preview command allows you to preview your site locally after building to catch any errors in your build output before deploying it by starting a local server to serve the contents of your static directory (dist/ by default) created by running astro build. The command is not designed to be run in production.

  npm run preview

Contributing

Found some important information missing? Please open a Pull Request and help improve this project. We welcome contributions of all kinds, whether it's adding new terms, fixing typos, or suggesting new features.

Issue Templates

• To add new terms: View Template
• To report a bug: View Template
• Feature requests or anything else: Create your own issue 🐳

How to Contribute (PRs)

1. Fork the Repository:

   • Start by forking this repository to your own GitHub account. This creates a copy of the repository under your GitHub account where you have full control.

2. Clone the Repository:

   • Once you have forked the repository, clone your fork to your local machine to start working on the project.
   • Use the following command to clone the repository:

     git clone https://github.com/your-username/Dev-Encyclopedia.git

   • Replace your-username with your GitHub username.

3. Create a New Branch (Optional but Recommended):

   • We recommend creating a new branch for your changes to keep your develop branch clean and to isolate your work.
   • Use the following command:

     git checkout -b feature-branch

   • Replace feature-branch with a name that reflects the work you’re doing (e.g., add-content, fix-typo).

4. Make Your Changes:

   • Make the necessary changes to the HTML files or any other content in the repository.

5. Commit Your Changes:

   • After making your changes, commit them with a brief and descriptive message:

     git add .
     git commit -m "Brief description of the changes"

6. Push to GitHub:

   • Push your changes to your forked repository:

     git push origin feature-branch

7. Open a Pull Request:

   • Go to the original repository on GitHub and open a Pull Request (PR) from your branch to the develop branch.
   • Make sure to describe the changes you’ve made and why they’re beneficial to the project.

8. Get Your PR Merged:

   • Once your PR is reviewed and approved, it will be merged into the develop branch. After thorough testing, the develop branch will be merged into the main branch for deployment (please note that this may take 2-3 days).

IMPORTANT: This project uses the main branch for deployment and the develop branch for active development. All contributions should be made to the develop branch, which will be tested and reviewed before being merged into the main branch for deployment.

Thank you for contributing to the Dev Encyclopedia!

🎖️ Notable Contributors

We are grateful to our outstanding contributors who have significantly impacted this project. Check out their profiles below!

Contributor Name	LinkedIn	GitHub
Ray Mathew (@RayMathew)
Amine Naqi (@Rodelph)
Sudharshaun Mugundan (@Sudharshaun)
Kwong Cheong N. (@KC900201)

Sponsoring

A few dollars toward hosting and domain costs would be appreciated! Also, a sponsor page would be dedicated to the website so it's a win-win.

License: CC BY-NC-SA 4.0

This project, Dev Encyclopedia, is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License. You are free to share and adapt the content for non-commercial purposes, as long as you give appropriate credit and share any derivative works under the same license. For more details, see the full license.