akhilkala/muncoordinated-2

🇺🇳 Muncoordinated is a Model UN committee management service, (re)written with TypeScript, React, Semantic UI and Firebase.

Muncoordinated

Muncoordinated is a Model UN committee management service, (re)written with TypeScript, React, Semantic UI and Firebase, and available at muncoordinated.io.

Background

This version of Muncoordinated began development at the end of 2017, ahead of SydMUN 2017. It began as a reimplementation of a previous version of Muncoordinated, built in Elm. The current version of Muncoordinated was my (@MaxwellBo) first real foray into frontend development, React, TypeScript, and UI design. This means that some of the old code in here is, frankly, shockingly bad. Furthermore, a lot of features were either rushed out before conferences, or during debate. Neither documentation or tests were written.

Ultimately, this is a personal project that ballooned in scope and LOC - contributing to this will be difficult. Absolutely feel free to contact me if you'd like to contribute; I'll gladly guide you through the ugly hacks and shaky foundations.

Development

yarn && yarn start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

Tests

yarn test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

Integration tests

yarn run cypress

Launches the integration test runner.
See the section about The Test Runner

Building

yarn build

Builds the app for production to the build folder.
It will bundle React in production mode and optimize the build for the best performance.

The build is minified and the filenames include the hashes.

Maintainers

@MaxwellBo.

Contributing

Feel free to dive in! Open an issue or submit PRs.

You might also want access to some of the SaaS services that we've used to build Muncoordinated:

• Public Netlify deployment status
• Public Cypress integration test run recordings
• Private Sentry error logging (access available upon request)
• Private Google Analytics (access available upon request)

Learn More

You can learn more in the Create React App documentation.

To learn React, check out the React documentation.

Contributors

This project exists thanks to all the people who contribute. Special thanks to:

• UQ United Nations Student Association

License

GNU GPLv3 © Maxwell Bo