Git Product home page Git Product logo

period's Introduction

Period

How can you deal with it your menstrual cycle data while making sure big tech and health insurances do not have access to it?

Track your period without worrying about data privacy.

๐Ÿ’พ Installation

  • Place this app in <path to nextcloud>/apps/
  • Enable it

โš™๏ธ Building the app

Requirements

๐Ÿ“ General build instructions

  • Install PHP dependencies: composer install --no-dev
  • Install JS dependencies: npm ci
  • Build JavaScript for the frontend
    • Development build npm run dev
    • Watch for changes npm run watch
    • Production build npm run build

๐Ÿ‹ Docker: Simple app development container

  • Fork the app
  • Clone the repository: git clone https://github.com/camilasan/period.git
  • Go into deck directory: cd period
  • Build the app as described in the general build instructions
  • Run Nextcloud development container and mount the apps source code into it:
docker run --rm \
    -p 8080:80 \
    -v ~/path/to/app:/var/www/html/apps-extra/app \
    ghcr.io/juliushaertl/nextcloud-dev-php80:latest

๐Ÿค“ https://juliushaertl.github.io/nextcloud-docker-dev/basics/standalone/

๐Ÿ‘ฉโ€๐Ÿ’ป Full Nextcloud development environment

  • You need to setup a development environment of the current Nextcloud version.
  • Alternatively you can use the nextcloud docker container.
  • After the finished installation, you can clone the deck project directly in the /[nextcloud-docker-dev-dir]/workspace/server/apps/ folder.

๐Ÿค“ https://juliushaertl.github.io/nextcloud-docker-dev/basics/stable-versions/

Running tests

You can use the provided Makefile to run all tests by using:

make test

This will run the PHP unit and integration tests and if a package.json is present in the js/ folder will execute npm run test

Of course, you can also install PHPUnit and use the configurations directly:

phpunit -c phpunit.xml

or:

    phpunit -c phpunit.integration.xml

for integration tests.

period's People

Contributors

camilasan avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.