Skip to content

Latest commit

 

History

History
124 lines (70 loc) · 4.51 KB

README.md

File metadata and controls

124 lines (70 loc) · 4.51 KB
Raw

UDYOG SAARTHI APP

Welcome to UDYOG SAARTHI APP, a project developed for the Smart India Hackathon 2023. This application, built with React, Vite, and Appwrite, is designed to address the employment challenges faced by Persons with Disabilities (PwDs) in our country.

Features

  • Learning Profile: Candidates can create a comprehensive learning profile, including UDID, literacy, skills training, address, and functional difficulties faced. This profile also covers assistive devices, human assistance requirements, and aspirations.

  • Job Notifications: Receive notifications about job opportunities, both in the government and private sectors, in line with the 4% reservation for PwDs in Government and PSU Jobs.

  • Important Dates: Stay informed about crucial dates related to job applications, examinations, and interviews.

  • Educational Support: Access model question papers, practice materials, and mock tests to prepare for qualifying examinations.

  • Application Tracking: Track the status of job applications, examinations attended, interviews qualified, and placement details.

  • Workplace Support: Request assistance for workplace adaptations or reasonable accommodations to sustain employment.

  • Skills Training Programs: Receive notifications about skills training programs offered by the Department of Adult Independent Living (DAIL), NIEPMD, and other related organizations.

Technologies Used

  • React: The frontend is built using the popular React library, ensuring a responsive and dynamic user interface.

  • Vite: Vite is employed as the build tool for the project, providing fast and efficient development and production builds.

  • Appwrite: The backend is powered by Appwrite, an open-source platform that simplifies the development of scalable and secure web applications.

Getting Started

To get started with UDYOG SAARTHI APP, follow these steps:

  1. Clone the Repository:

    git clone https://github.com/hallowshaw/udyog-saarthi-app.git
cd udyog-saarthi-app

  2. Install Dependencies:

    npm install

  3. Run the Application:

    npm run dev

This will start the development server, and you can access the app at http://localhost:3000.

  1. Build for Production: 
    npm run build

This command generates optimized and minified production-ready files.

Contributing to UDYOG SAARTHI APP

Thank you for considering contributing to UDYOG SAARTHI APP. By contributing, you help make this project better and support the open-source community. We appreciate your time and effort.

Code of Conduct

Before you start contributing, please read our Code of Conduct. We expect all contributors to abide by this code to ensure a positive and inclusive environment.

How to Contribute

  1. Fork the repository to your GitHub account.

  2. Clone the forked repository to your local machine.

    git clone https://github.com/hallowshaw/udyog-saarthi-app.git

  3. Create a new branch for your changes.

    git checkout -b feature/your-feature-name

  4. Make your changes, and ensure that your code follows the project's coding standards.

  5. Test your changes locally to make sure they work as expected.

  6. Commit your changes with clear and concise commit messages.

    git add .
git commit -m "Add your descriptive commit message"

  7. Push your changes to your forked repository.

    git push origin feature/your-feature-name

  8. Open a pull request (PR) against the main branch of the original repository.

  9. Your PR will be reviewed, and feedback may be provided. Make any necessary changes and update your branch.

  10. Once your PR is approved, it will be merged into the main branch.

Bug Reports and Feature Requests

If you find a bug or have a feature request, please open an issue on our Issue Tracker. Provide detailed information and, if applicable, steps to reproduce the issue.

Coding Standards

Please adhere to the coding standards used in this project. If there are specific guidelines, they will be mentioned in the project's documentation.

License

By contributing to UDYOG SAARTHI APP, you agree that your contributions will be licensed under the MIT License.

Thank you for contributing to UDYOG SAARTHI APP! 🚀