Skip to content
This repository has been archived by the owner on May 17, 2023. It is now read-only.

Latest commit

 

History

History
100 lines (76 loc) · 4.56 KB

README.md

File metadata and controls

100 lines (76 loc) · 4.56 KB
Raw

Stargazers Contributors Issues License

ClubIS

ClubIS is an information system for any Czech orienteering club. The core functionality includes management of Members data, Event entries and Finance. Tight integration with Oris is planned to be implemented. The goal is to create a modern open-sourced and maintained information system to create an alternative for other outdated https://members.eob.cz/ or paid https://www.privatni-zona.cz/ solutions.

Preview

To Do List

  • Dev Wiki / Documentation
  • Logging
  • Mail remainders
  • Database backup / restore
  • Oris integration
  • Localization
  • Tests

Built With

  • .NET 6 | .NET Framework and .NET Core marged into multiplatform (Windows/Linux) .NET 6
  • Blazor | component-based C# framework for creating web UI
  • MudBlazor | Material Design component library for Blazor

Development

Prerequisities

Before you begin, ensure you have installed the .NET 6.0 SDK.
PostgreSQL database server needs to be set up.

docker run --rm --name clubis-postgres-db -p 127.0.0.1:5432:5432 -e POSTGRES_PASSWORD=postgres -d postgres

Running

Using your favourite C# devolopment IDE, set ClubIS.WebAPI as your startup project and run the app.
As an alternative, you can use .NET CLI and start the project by exucuting dotnet run in the WebAPI folder as the current directory.
A web browser should be launched with the application running and fetching data from the API. Summary of the available API calls from the controllers will be at http://localhost:{port}/swagger/index.html, although most of the calls require you to log in to the application first in order to obtain the authorization cookie.

Deploy

Edit databse credentials in connection string and docker-compose file and run the docker-compose. The app is running at port 5100, set up reverse proxy to serve the app with HTTPS.

Contributing

For feedback and any brilliant ideas for improvement (or even tiny little tweaks), feel free to open an issue or contact me at otakar.hirs@gmail.com. Any contributions you make are greatly appreciated. For contributing directly:

  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

I advise you, before opening a merge request, open related issue to discuss the upcoming changes first.

Acknowledgements

Thanks to the following people who have contributed to this project:

License

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