Troop 156 is an exciting online platform designed exclusively for Cub Scouts and their families, bringing together a community of young explorers and their enthusiastic parents. Our interactive website serves as the ultimate hub for all things scouting, offering a seamless registration process, captivating event listings, and a wealth of resources to enhance your scouting journey.
To run this project locally, please follow these steps:
- Clone the repository
https://github.com/yubinjodev/troop156-solarias.git
- Navigate to the project directory
cd troop156-solarias
- Install the dependencies
npm install
Once the installation is complete, you can start the development server by running the following command:
npm start
This will start the application at http://localhost:3000 in your browser. Any changes you make to the source code will automatically refresh the page.
- Authentication
- Login
- Sign up as a Scout
- Sign up as a Parent
- Events
- See list of events
- Sign up for events
This project utilizes the following technologies:
- Language : Typescript
- Framework : React
- Build tools : NPM
- CSS Framework : Material UI
- State Management : Redux & Redux Persist
- API Client : Axios
- Unit testing : Jest
- E2E testing : Playwright
Contributions to this project are welcome. If you find any issues or have suggestions for improvements, feel free to open a new issue or submit a pull request. Not sure how to do that? Check this out
When contributing, please adhere to the existing code style and follow the GitHub Flow for collaboration.
This project is licensed under the MIT License. You are free to use, modify, and distribute this code as long as the original license terms are included.