README.md

Periodo - The Tracker (Period Tracker) ✨

About 📚

Periodo - The Tracker focuses on young girls who are going to experience their first periods and the women who face problem tracking their period dates and remembering their dates be it for avoiding embarrassing moments or to monitor your period for lifestyle disorders(PCOS,PCOD,etc.). Our application Periodo can help these girls and women by keeping a track of their periods and notifying them on their upcoming dates along with keeping track on the level of flow of their periods also helping them with their correct diet in their period days. We have planned to add more features in the application as it grows with the help of contributors. The Project is very beginner friendly to contribute to as well as has a user-friendly interface which can help in attracting young 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 click 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 dicrectory:

  • 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

Contact Us ☎️

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

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

Genral Guidelines for Contributors 🚧

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

1. Participant can be assigned to only one issue at a single time (please refrain from asking new issues until your work in an issue is completed), So that every contributer gets the equal chance to contribute and collaborate in the project.
2. Every Participant who are assigned in a issue have to give regular updates after every three three days otherwise the issue will be made available again.
3. Issues will get assigned on 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 atleast 3-4 days after submitting a PR. Maintaners 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 following program