/ResQSyncWeb

Offical web application for ResQSync app, giving brief about the app itself

Primary LanguageTypeScript

Untitled

ResQSync

The official website for the ResQSync mobile application contains the basic info that we offer in our app not to mention the TODOs board

Code Contributors

Thanks to these code contributors who keep this project going

Contributions

We always welcome any contributors, and you can start contributing immediately if you desire. Feel free to join our Discord: #ResQSync-web to join the community, or if you need help with the below.

If you are a new developer looking to contribute something to ResQSync, please take a look and see if there's anything that you'd like to work on in the issue tracker.

The "Good First Issue" label has been added to any tasks that seem like a good way to get started working with the codebase.

If you are looking to make a lasting impact on the project from the get-go, issues with the label "Help Wanted" are tasks that we'd really like to have done but don't yet have time to do ourselves.

Please let us know that you're working on an open issue and let us assign it to you, this ensures that two people aren't working on the same issue, and ensures that all effort is valuable to the project. If an issue hasn't seen activity in a couple of weeks, feel free to ping the assignee to see if they're working on it, or ask a maintainer to reassign the issue to you.

If you can't work on an issue anymore, please post another message to let us know.

If it's unclear exactly what needs to be done, or how to do it, please don't hesitate to ask for clarification or help!

Project Setup Guide

We use Next js 13 to set up locally follow the below steps :

  1. Run npm install first to install all the required libraries or dependencies for the project.
npm install
  1. Run the project in your browser, we are running on PORT:3000 by default.
npm run dev
  1. Open http://localhost:3000 with your browser to see the result.

You can start editing the page by modifying app/page.tsx. The page auto-updates as you edit the file.

Pull Requests & Issues

  1. When making a pull request make sure that the PR template is properly filled and you go through the checklist before submitting your PR.
  2. Issues should be well-detailed or attached screenshots if applicable, we will get to your reported issue as soon as possible as we all are volunteers and give our free time to ResQSync and does not work full time for the same.