Maths Number Bonds

Help your students practice and assess their number bonds. See how quickly they are solving problems and print their results to PDF.
View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
   • Development
   • Building
3. Roadmap
4. Customising this project
5. Contributing
6. License
7. Contact

About The Project

Built With

• React

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

You need to install the following software to run this project:

• npm

  npm install npm@latest -g

Installation

1. Clone the repo

   git clone https://github.com/ianholden123/maths-number-bonds.git

2. Install NPM packages

   npm install

Development

• To run the app in development mode, run the following script:

  npm start

• Open http://localhost:3000 to view it in the browser.

Building

• To build the project in preparation for it to be hosted on a production environment, you must run the following script:

  npm run build

• This will build the app for production to the build folder. It correctly bundles React in production mode and optimizes the build for the best performance. The build is minified and the filenames include the hashes. Your app is ready to be deployed!

Testing

• Run the following script to launch the test runner in the interactive watch mode:

  npm test

Roadmap

See the open issues for a list of proposed features (and known issues).

Customising this project

Some additional configurations can be made before building the project by accessing the configuration files in the /src/config directory.

If you intend on making changes to the colour of each phase in the /src/config/phases.js file, be aware that HEX colour values will work best. For example, instead of using a colour value such as blue, use #0000ff. Note that we have specified the hash (#) before the RGB value too. This is important for manipulating the font colour on the results grid.

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

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

Please see the following documents for more details on how you can contribue and our code of conduct.

License

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

Contact

Ian Holden - Website - ianholdendev@outlook.com