Skip to content

Latest commit

 

History

History
229 lines (171 loc) · 11.3 KB

README.md

File metadata and controls

229 lines (171 loc) · 11.3 KB



Checkpoint

Checkpoint is a mobile attendance system built to eliminate the time and effort wasted in taking attendances in schools and colleges. It also greatly reduces the amount of paper resources needed in attendance data management.

☁ Documentation

For full documentation, visit Documentation

🛠️ Built With

This project was developed using a diverse set of frameworks and libraries, which contributed to its robustness and efficiency.

Here are the major technologies utilized:

  • Next
  • React
  • Vue
  • Angular
  • Svelte
  • Laravel
  • Bootstrap
  • JQuery

With this diverse technology stack, the project achieves a well-rounded combination of cutting-edge frontend and backend tools, ensuring a smooth and feature-rich user experience.

(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)

💪 What can I contribute?

You can contribute to Checkpoint in any form that you would like to! For instance, you may:

  • Participation in the community, by answering questions on GitHub open issues and in our chat groups, helps us maintain a healthy and active community of users.
  • We welcome your proposals for new features, as well as reporting issues and bugs to Checkpoint .
  • Submit codes to Checkpoint .
  • Other contributions include suggestions for website improvements and documentation.
  • Become a Top Genus Committer!

📐 The contribution workflow

Here's a step-by-step guide to contributing code to Kanaries RATH:

  • Take a look at the existing Issues or create a new issue.
  • Fork the Repo into your github account. Create a branch for any issue that you are working with, and commit your work.
  • Create a Pull Request (a.k.a. Create a PR). We will review and process your Pull Request.
  • Now that your Pull Request has been approved, you've officially become a Genus Committer!

🐞 How can I report an issue?

The open-source community values constructive questions. Before submitting an issue, make sure you have done your research and reviewed the following:

  • Avaialble documentations and FAQ.
  • Opened issues on our GitHub repo.
  • Existing Pull Requests.

Then you can open a new Issues on the GitHub page with a detailed description of the problem. The community will be happy to help!

(back to top)

📐 Join the Developer List

To foster a sense of community and to recognize the contributions of each participant, we encourage you to include your details in the Developers List located in the repository. Here's how you can do it:

a. In the repository's root directory, find to the "developers_list.md" file.

b. Open the "developers_list.md" file.

c. Add your name, GitHub username, and a brief description (optional) about yourself to the list. You can use the following format:

- Name: John Doe
  GitHub: johndoe
  Description: Front-end enthusiast, passionate about UI/UX design.

d. Save the changes to the file and commit them to your local repository.

e. Create a new branch (optional) and push your changes to the remote repository.

f. Submit a pull request (PR) with your modifications to the main branch of the project repository.

If you have any questions or encounter any issues during this whole process, please reach out to our support team at support-email@example.com.

(back to top)

Sure! Let's convert the software steps from the previous result into the specified format:

🆕 Roadmap

  • Install Python and Kivy
  • Create Check App:
    • Design user interface using Kivy's KV language or Python code
    • Implement user registration functionality to store individual data (name, ID, etc.)
    • Add QR code scanning functionality using Kivy's camera module or a third-party QR code scanner library
    • Implement attendance recording and local storage to log attendance data
  • Create Point App:
    • Design user interface to set up new meetings and generate QR codes using Kivy widgets
    • Generate one-time use QR codes containing meeting/session details using Kivy's QR code generation feature or a third-party library
  • Data Export:
    • Implement export functionality in the Check App to export attendance data in various formats (CSV, Excel, PDF)
    • Use Python's built-in file I/O or libraries like Pandas to handle data export
  • Internet Connectivity:
    • Ensure that the Point App and Check App have access to the internet to generate and verify QR codes. You may need to implement network-related functions or check internet connectivity.
  • User Interface Design:
    • Focus on creating a user-friendly and intuitive interface for both the Check App and Point App using Kivy widgets and layouts.
  • Security Measures:
    • While Kivy provides some basic functionality for UI security, you may need to consider additional security measures for QR code verification and data storage.
  • Testing and Debugging:
    • Regularly test your apps on various devices and operating systems to ensure compatibility and responsiveness.
    • Perform thorough testing to identify and fix any bugs or issues.
  • Deployment:
    • Once your apps are ready, you can package them for distribution to users. Kivy supports multiple platforms, including Windows, macOS, Linux, Android, and iOS.
  • Data Privacy and Consent:
    • Ensure that you comply with data privacy laws and obtain proper consent from individuals for collecting and storing their attendance data.

(back to top)

💼 License

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

(back to top)

📱 Contact Us on Twitter

Do you have any questions, feedback, or inquiries ? We'd love to hear from you! Reach out to us on X App, and our dedicated team will be delighted to assist you.

Tweet us @genus_softorg, and we'll ensure a prompt response to your messages. Whether it's about our products, services, or any other matter related to our organization, we're here to help.

Join our Twitter community today and stay updated with the latest news, events, and announcements. We look forward to engaging with you on our social media platform!

#ContactUs #CustomerSupport #SocialMedia

Send us a DM on the X App - Genus Software Organizaiton

(back to top)

🙏 Acknowledgments

We would like to express our heartfelt gratitude to the following platforms, whose exceptional tools and resources played a pivotal role in bringing this project to life

(back to top)