Skip to content

Administration for clubs for information access and scheduling.

License

Notifications You must be signed in to change notification settings

isaacwuerth/owls

Contributors Forks Stargazers Issues GNUv3 License


Logo

owls

Administration for clubs for information access and scheduling.
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

TODO Create a description of the project.

Built With

This project was build with:

  • React
  • recoil
  • Material UI

(back to top)

Getting Started

This section explains on how to setup this project on your own.

Prerequisites

  • npm
    npm install npm@latest -g

Installation

  1. Clone the repo
    git clone https://github.com/isaacwuerth/owls
  2. Create a .env file in the root directory and add the following or copy the .env.example file.
     REACT_APP_VERSION=
     REACT_APP_NAME=
     REACT_APP_FIREBASE_API_KEY=
     REACT_APP_FIREBASE_AUTH_DOMAIN=
     REACT_APP_FIREBASE_DATABASE_URL=
     REACT_APP_FIREBASE_PROJECT_ID=
     REACT_APP_FIREBASE_STORAGE_BUCKET=
     REACT_APP_FIREBASE_MESSAGING_SENDER_ID=
     REACT_APP_FIREBASE_APP_ID=
     REACT_APP_FIREBASE_MEASUREMENT_ID=
     REACT_APP_SENTRY_DSN=
     REACT_APP_SENTRY_AUTH_TOKEN=
     REACT_APP_SENTRY_ORG=
     REACT_APP_SENTRY_PROJECT=
     REACT_APP_SENTRY_RELEASE_VERSION=
     REACT_APP_SENTRY_ENVIRONMENT=
     REACT_APP_OPENREPLAY_PROJECTKEY=
  3. Install NPM packages
    npm install
  4. Build it
    npm run build
  5. Run it
    npm start

(back to top)

Usage

This project was created for a field hockey club for better planning and information distribution.

(back to top)

Roadmap

  • File manager

  • Calendar

  • User management

  • User roles

  • User permissions

  • 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.

Please follow the Contribution Guidelines when contributing to this project.

(back to top)

License

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

(back to top)

Contact

Isaac Würth - @isaacwuerth - isaac.wuerth[at]outlook.com

Project Link: https://github.com/isaacwuerth/owls

(back to top)

Acknowledgments

Some helpful links used to create this project

I've included a few of my favorites to kick things off!

(back to top)

About

Administration for clubs for information access and scheduling.

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •