Periodo - The Tracker (Period Tracker)

About

Our project focuses on the young girls who are going to face their first periods or the females who have been facing problems with tracking their period dates and remembering their dates and end up embarrassing themselves when they face their periods at wrong time at wrong places. Our application perido 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 dates. 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

ReactJS
NextJs

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
```

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

Documentation

Please read CONTRIBUTING.md and Code of Conduct before contrbuting

Contact

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

Guidelines for Contributors

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

One participant can only be assigned to one issue at one time , So that everyone will get the chance to Contribute and to create any fuss in the organization.
Every Participant who are assigned in a Issue have to give any update within three days otherwise the next person who is interested will be assigned on that issue.
An issue will get assign to those who comes first to comment. If He/She is unable to give any update within 3 days. The person who is next in the queue will get assigned.

Chaitalishetty/periodo