Katydid-web-client

The frotend repo for Katydid project
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Contributors

About The Project

Check out a live demo here.

Katydid is a web application for a daycare service. This application empowers parents and guardians to pursue their professional goals and also look after their ward.

This application has features like: listing all children that are in the daycare service on a particular day and time, examining a child's meal log entries etc.

Built With

• react
• material-ui
• redux
• firebase
• axios
• clsx
• serve
• prop-types
• react-router-dom
• react-dom

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

• npm
• node

Installation

1. Clone the repo

git clone https://github.com/code-sherpas/katydid-web-client.git

2. Install NPM packages

npm install

3. Add the necessary environment variables to a .env file.

{
        echo '  REACT_APP_FIREBASE_API_KEY='
        echo '  REACT_APP_FIREBASE_APPID='
        echo '  REACT_APP_FIREBASE_AUTH_DOMAIN='
        echo '  REACT_APP_FIREBASE_MEASUREMENT_ID='
        echo '  REACT_APP_FIREBASE_MESSAGING_SENDER_ID='
        echo '  REACT_APP_FIREBASE_PROJECT_ID='  
        echo '  REACT_APP_FIREBASE_STORAGE_BUCKET='
        echo '  REACT_APP_BACKEND_URL='
} >> .env

Usage

1. Start react app

npm start

Roadmap

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

Contributing

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

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

License

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