Tiffin Management System App - Hacktoberfest 2024 🎉

Tiffin Management System

Welcome to the Tiffin Management System app, a React Native project that simplifies managing tiffins for both students and owners. This project is open to contributors, especially during Hacktoberfest 2024! We encourage you to collaborate and contribute to the development of this app.

About the Project

The Tiffin Management System App is designed to streamline daily tiffin services by offering features for both students and owners. The app allows users to manage attendance, view dashboards, update profiles, and much more. It is built using React Native and Expo, ensuring a cross-platform experience on Android and iOS.

Getting Started

Prerequisites

Ensure you have the following installed on your local machine before starting:

  • Node.js (version 14.x or later)
  • Yarn (Node Package Manager)
  • React Native CLI
  • Expo CLI

Installation

  1. Clone the repository:

    git clone https://github.com/ArohiSoftwares/tiffin-management-system
  2. Navigate into the project directory:

    cd tiffin-management-system
  3. Install the required dependencies:

    yarn install
  4. Start the Expo development server:

    npx expo start
  5. Run the app: Select your device (Android, iOS simulator, or web) to run the app.

Features

For Owners

  • Dashboard with income and attendance statistics
  • Attendance management system
  • Profile management

For Students

  • View attendance history
  • Track remaining balance
  • Edit profile information

Tech Stack

This project is built using:

  • React Native: for creating cross-platform mobile applications.
  • Expo: for building and deploying React Native apps quickly.
  • JavaScript/ES6: for coding the logic and functionality.

Contributing

We welcome contributions from everyone, especially during Hacktoberfest! Whether you’re a seasoned developer or new to open-source, you can contribute to this project. Every pull request will be reviewed and merged after proper evaluation.

Hacktoberfest Guidelines

  1. Fork the repository.
  2. Pick an issue from the Issues section. Look for issues labeled with Hacktoberfest or good first issue.
  3. Create a branch for your issue:
    git checkout -b issue-<ISSUE_NUMBER>
  4. Make your changes.
  5. Commit your changes and push the branch to your forked repository.
  6. Submit a Pull Request (PR) and link it to the issue you’re resolving.

We encourage you to read our Code of Conduct and Contributing Guidelines before submitting any code.

How to Contribute

  1. Clone the repository to your local device.
  2. Follow the installation steps mentioned above to set up the project on your local machine.
  3. Check the open issues and pick one to work on.
  4. Submit your Pull Request (PR) once you’re done. Make sure to reference the issue number your PR addresses.

Example Commands

Fork the repo:

git clone https://github.com/yourusername/tiffin-management-system.git

Create a new branch:

git checkout -b new-feature-branch

Commit changes:

git add .
git commit -m "Added new feature X"

Push and create a pull request:

git push origin new-feature-branch

Issues

We use GitHub Issues to track bugs, feature requests, and improvements. If you find any issues in the app or have suggestions, feel free to raise an issue and we'll review it promptly.