Welcome to the official repository of dmj.one, an initiative dedicated to providing quality education for all, especially for underprivileged children.

Empower your dreams, manifest success, journey as one at dmj.one.

dmj.one is dedicated to bridging the education gap by providing free and accessible educational resources for Computer Science and Engineering (CSE) enthusiasts. Our mission is to ensure everyone, regardless of socio-economic background, has access to high-quality education in computer science.

For more details on our mission, vision, and offerings, please visit our GitHub organization page.

One of the easiest ways to contribute to the dmj.one project is by making changes directly on the GitHub website. This method is especially user-friendly and does not require any special software or setup. Here's how you can do it:

1. Navigate to the Repository:

   • Go to the dmj.one repository on GitHub.

2. Find the File to Edit:

   • Browse through the files in the repository to find the one you want to edit. You can do this by clicking on the file name in the repository's file list.

3. Edit the File:

   • Click the pencil icon (🖉) in the upper right corner of the file view. This will open the file in the GitHub web editor.
   • Make your desired changes directly in the web editor.

4. Propose Changes:

   • Once you have made your changes, scroll down to the "Propose changes" section.
   • In the "Edit file" tab, you can add a title for your changes and a brief description in the text boxes provided.
   • Ensure the "Create a new branch for this commit and start a pull request" option is selected.

5. Create a Pull Request:

   • Click the "Propose changes" button.
   • You will be directed to a new page where you can review your proposed changes. Click the "Create pull request" button to submit your changes for review.

This method is a quick and efficient way to contribute to the project, especially for minor changes or documentation updates. It allows you to participate in the project without needing to clone the repository or set up a local development environment.

Another way is To get a local copy up and running. To do that, follow these simple steps.

Before you begin, ensure you have met the following requirements:

• You have a GitHub account.
• You have installed Git.

1. Clone the repository:

   git clone https://github.com/dmjone/dmjone.git

2. Navigate to the project directory:

   cd dmjone

The dmj.one website is automatically deployed to GitHub Pages and Cloudflare Pages upon pushing changes to the repository. This section describes the deployment process in detail, including safety and security checks.

The site is hosted on GitHub Pages. Follow these steps to ensure proper deployment:

1. Enable GitHub Pages:

   1. Go to your repository settings.
   2. In the "Pages" section, set the source to the main branch or a specific folder like /docs.

2. Configure Deployment:

   1. Ensure that the _config.yml file (if using Jekyll) or equivalent configuration files are set up correctly.
   2. Verify the GitHub Actions workflow for deployment is configured properly in the .github/workflows/ directory.

Cloudflare Pages is also set up for deployment. Follow these steps:

1. Connect Repository:

   1. Log in to Cloudflare and go to the Pages section.
   2. Connect your GitHub repository and follow the setup instructions.

2. Configure Deployment:

   1. Ensure the build settings and environment variables are configured properly in the Cloudflare Pages dashboard.

Before deployment, a series of safety and security checks are performed to ensure the integrity and security of the codebase. These checks include:

1. Code Quality Checks:

   1. Automated code quality tools such as CodeQL are used to analyze the code for potential vulnerabilities and code quality issues.

2. Security Scanning:

   1. Security scanning tools are integrated to detect and prevent vulnerabilities in the codebase.

3. Automated Tests:

   1. Run automated tests to ensure that the website functions correctly before deploying.

These checks are integrated into the GitHub Actions workflows, and their statuses can be monitored under the "Actions" tab of the repository.

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

There are several ways you can contribute to this project:

1. Fork the repository and make changes locally:

   1. Fork the repository by clicking the "Fork" button at the top right of the repository page.
   2. Clone the forked repository to your local machine:

      git clone https://github.com/your-username/dmjone.git

   3. Create a new branch:

      git checkout -b feature/YourFeature

   4. Make your changes and commit them:

      git commit -m 'Add some feature'

   5. Push to the branch:

      git push origin feature/YourFeature

   6. Open a pull request by going to your repository on GitHub and clicking the "New pull request" button.

2. Live editing on GitHub:

   1. Navigate to the file you want to edit on the dmjone repository.
   2. Click the pencil icon (🖉) in the upper right corner of the file view to edit the file.
   3. Make the desired changes directly in the web editor.
   4. Scroll down to the "Propose changes" section.
      • In the "Edit file" tab, you can add a title for your changes and a brief description in the text boxes provided.
      • Ensure the "Create a new branch for this commit and start a pull request" option is selected.
   5. Click the "Propose changes" button.
   6. You will be directed to a new page where you can review your proposed changes. Click the "Create pull request" button to submit your changes for review.

3. Reporting Issues:

   1. Go to the Issues section of the repository.
   2. Click the "New issue" button.
   3. Provide a clear and descriptive title for your issue.
   4. Fill in the issue template with relevant information about the issue you're experiencing or the feature you'd like to suggest.
   5. Click the "Submit new issue" button.

By following these steps, even those who are not highly familiar with tech can contribute to the project effectively. For more detailed instructions, you can refer to the GitHub Flow guide.

Thank you for your contributions!

Distributed under the GNU Affero General Public License, version 3 or later. See LICENSE for more information.

Project Link: https://dmj.one/

Founder / Project Lead / Legal: Divya Mohan - LinkedIn - Email

To view the full list of contributors, please visit our GitHub Contributors Page.

We extend our heartfelt gratitude to our distinguished contributors:

Your dedication and hard work make this project possible. Thank you!

© dmj.one