Periodo - The Tracker (Period Tracker) ✨

About 📚

Periodo - The Tracker is designed for teenage girls about to start their periods and women who have trouble recalling their period dates, whether it's to prevent embarrassing situations or to check the period for lifestyle disorders (PCOS, PCOD, etc.). By keeping track of their cycles and notifying them, our app Periodo will assist these girls and women. Periodo will assist these girls and women by keeping track of their periods and notifying them of upcoming dates, as well as keeping track of the amount of discharge of their periods and assisting them with proper diet during their periods.We want to expand the application's functionality as it expands with the assistance of contributors. The project is really beginner-friendly to contribute to, and it has a user-friendly interface that may appeal to a younger audience.

Project's Demo Video : 📺 https://youtu.be/3dxa599SPT4

Tech Stack 🚀

Local Setup Instructions 💻

Follow these steps to setup project locally:

• Fork the repository: Click the fork button.
• Clone forked repository: If you are using Windows OS use Git Bash to run all commands given below.

  #to clone the repository
  git clone https://github.com/<your GitHub user name>/periodo.git
  #Example
  git clone https://github.com/johnDoe/periodo.git

• Add remote: This will point to the original repository. It will help you to get the latest changes made by others.

  #add upstream
  git remote add upstream https://github.com/Feminine-Divine/periodo.git

Two Ways to Install from here:

1. Without using Docker i.e Conventional Way

• Install yarn: This project use yarn as a package manager.

  #to check yarn installed on your computer or not
  yarn --version
  #to install yarn
  npm install --global yarn

• Install dependencies:

  #move to directory
  cd periodo/periodo
  #install the dependency
  yarn install
  #or
  npm install

• Run the project:

  #run in the development mode
  yarn dev
  #or
  npm run dev

  Check-in which port, the server is running or clicks the link

2. Using Docker

• Install Docker, from the given link.

• Once Docker is installed, use the following two commands to run the app in the root directory:

  • docker-compose build, This command will build the project
  • docker-compose up, This command will run the container.

• You can open the project on localhost:3000 on the machine.

Note: If you are using docker-desktop on Windows Or WSL2 i.e Windows Subsystem For Linux, you can use the GUI Options to run the containers

Documentation 📃

Please read CONTRIBUTING.md and Code of Conduct before contrbuting Do follow the commit conventions while making any commits.

Contact Us ☎️

Please reach out to the admins Khushi Gautam and Shipra Verma if you face any doubts or have any questions regarding the project.

Follow us on LinkedIn

Chat Channel:- For any queries post here Mentors will guide you here on Discord

General Guidelines for Contributors 🚧

Some Guidelines need to be followed to maintain the decorum in the community.

1. Participants can be assigned to only one issue at a single time (please refrain from asking about new issues until your work in an issue is completed) So that every contributor gets an equal chance to contribute and collaborate in the project.
2. Every Participant who is assigned to an issue has to give regular updates after every three days otherwise the issue will be made available again.
3. Issues will get assigned on a first come first serve basis. Although if the current assignee is unable to give any update within 3 days. The person who is next in the queue will get assigned.
4. Please try to wait at least 3-4 days after submitting a PR. Maintainers are also human beings and have to manage the whole project. (So, don't ping constantly for review)
5. Try to discuss your features and problems related to the issue or PR directly here on Github.

Open Source Programs ❣️

This Project is a part of the following program