Support education and innovation in New Zealand Schools with industry experts and volunteers in the classrooms
You don't need permission to help - its open.
This is an open source project and you are welcome to contribute at any level you feel comfortable. Find out more about the project at the Website and then...
- Say hello, or ask questions in the Gitter Chatroom
- email team@voluntarily.nz and tell us about yourself
- Start Reading documentation
- Build the code - below
- Add yourself to the CONTRIBUTORS file, check it in and send us a pull request - see this ticket VP-82
- Come along to a Drop in Wednesday Afternoon or after work social at our Auckland office
- Come along to one of our developer events - see http://voluntarily.nz for the latest details.
Voluntarily is based on the MERN (MongoDB, Express, React+Redux, Node) software stack but also uses next.js to keep things clean and simple. Everything should work out of the box. There are two choices:
-
install NodeJS and MongoDB and run locally - See here for detailed instructions
-
install Docker and run in a container - See here for detailed instructions
-
npm run dev- starts the development server with hot reloading enabled -
npm run build- bundles the code -
npm run test- start the test runner -
npm run start- runs production server -
npm run check-coverage- generates test coverage report -
npm run lint- runs standard to check for lint errors ( npm run fix to fix lint errors ) -
npm run storybook- starts the Storybook Component Library
Once you see the message "Voluntarily is running on port: 3122! Be Awesome!" then you can open your browser at http://localhost:3122.
If you see the message "Please make sure Mongodb is installed and running!" then go back and start mongod.
Press ctrl + c to exit the node application.