Skip to content

staticMetro/Project-Scarlet

Repository files navigation

Project-Scarlet

Contributors Forks Stargazers Issues MIT License LinkedIn


Logo

Periodic

Helping women across the globe with their health!
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

Logo

Introducing the Period and Ovulation iOS Application, Periodic, a user-friendly mobile app designed to help women track their menstrual cycle and ovulation period. The app is tailored to meet the needs of women who want to take charge of their reproductive health and achieve their family planning goals.

With the Periodic iOS app, users can log and track their menstrual cycles, including the start and end dates, flow intensity, and symptoms. The app also provides ovulation predictions based on the user's menstrual cycle data, enabling them to know the days when they are most fertile and plan accordingly. Additionally, the app offers personalized insights and health tips on reproductive health, allowing users to make informed decisions about their health and wellbeing.

The PPeriodic Application is a must-have for women who want to take charge of their reproductive health. With its intuitive interface and easy-to-use features, users can stay on top of their menstrual cycles and achieve their family planning goals. Whether you are trying to conceive or simply want to monitor your menstrual cycle, the Periodic iOS app is your ultimate companion. Download the app today and take the first step towards better reproductive health.

(back to top)

Built With

This section should list any major frameworks/libraries used to bootstrap your project. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.

  • Swift
  • iOS
  • Heroku
  • MongoDB
  • PostgreSQL
  • JSON
  • JSON Web Tokens
  • Material UI
  • React
  • Vue
  • Angular
  • Svelte
  • Laravel
  • Bootstrap
  • JQuery

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

  • npm
    npm install npm@latest -g

Installation

Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services.

  1. Get a free API Key at https://example.com
  2. Clone the repo
    git clone https://github.com/your_username_/Project-Name.git
  3. Install NPM packages
    npm install
  4. Enter your API in config.js
    const API_KEY = 'ENTER YOUR API';

(back to top)

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

(back to top)

Roadmap

  • Add Changelog
  • Add back to top links
  • Add Additional Templates w/ Examples
  • Add "components" document to easily copy & paste sections of the readme
  • Multi-language Support
    • Chinese
    • Spanish

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Your Name - @your_twitter - [email protected]

Project Link: https://github.com/your_username/repo_name

(back to top)

Acknowledgments

Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off!

(back to top)

About

To create an ovulation and period tracker for women

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published