Cubing Portugal

The Portuguese Cubing Community Website

🚀 Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

• Node.js
• Yarn

Development

Installing Yarn dependencies.

yarn install

Starting the development server.

yarn start

Running tests.

yarn test

Format the source code.

yarn format

Deployment

Bundling the app into static files for production.

yarn build

🤝 Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Please note we have a Code of Conduct, please follow it in all your interactions with the project.

🔀 Pull Request Process

1. It is advised to create a Pull Request if you are stuck (so others can help you) or when your feature is complete and tested.
2. To be merged, your Pull Request must have a passing build on the Continuous Integration server (not applicable now).
3. To be merged, your Pull Request should add relevant tests (when applicable).
4. You may merge the Pull Request in once you have the sign-off of one other developer, or if you do not have permission to do that, you may request the reviewer to merge it for you. If you do have merging permissions on the repository, you must rebase and squash your Pull Request into a single commit.

📝 License

This project is licensed under the MIT License - see the LICENSE file for details.