Pierre-Do / club-event

A simple React app to register to a club event

Club Event

A simple form to register a person to a club event, with basic products management.

The backend is written in PHP. The frontend in React+Typescript.

Not generic at all.

Requirements

• Node 10+
• Docker
• docker-compose
• yarn

Getting Started

To start the dev server.

yarn
npm start

Starting frontend and backend with Docker

To test the PHP stuff. The php image contains Composer and should install the dependencies upon starting.

yarn
yarn start:int

Full validation

Lint, test, e2e.

yarn validate

e2e

Run the e2e tests in Docker with:

yarn build
yarn test:e2e

Contributing

Push any change in a branch and use the Pull Request system to ensure builds are being run before merging.

Releasing a version

To build a version deployable on the remote server:

• Copy api/configuration/_configuration.properties to api/configuration/configuration.properties
• Update api/configuration/configuration.properties with production values
• Run yarn validate
• Upon completion, deploy target/build to the root of the remote server

Requires PHP 5.2 and Apache2.

Acknowledgements

Thanks to the open source community for all the tools, especially:

• React
• @testing-library/react
• wait-for-it.sh
• Docker
• And others...

License

Copyright 2019 Pierre-Dominique Putallaz

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.