Giter VIP home page Giter VIP logo

voluntarily / vly2 Goto Github PK

View Code? Open in Web Editor NEW
107.0 31.0 55.0 62.38 MB

The Voluntarily Platform - an open source platform for organising volunteers to do cool things

Home Page: http://voluntarily.nz

License: Mozilla Public License 2.0

JavaScript 84.54% Dockerfile 0.04% HTML 12.72% Shell 0.27% Gherkin 0.03% Less 0.34% Pug 2.04% jq 0.01%
opensource volunteering volunteer-management teaching newzealand volunteer

vly2's Introduction

vly2

VLY2 test and build codecov License: MPL 2.0

COVID-19 - The platform is undergoing a major change to be able to support a wider range of volunteering activities.

This means that the code base is undergoing a rapid period of change. If you are considering using the platform in your own country please contact us about the best time to do that.

Stay Safe

How to join the Voluntarily community

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...

  1. Say hello on our Slack channel - Join here
  2. Start Reading documentation
  3. Build the code - below
  4. Add yourself to the CONTRIBUTORS file, check it in and send us a pull request - see this ticket VP-82

How to build it

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:

  1. install NodeJS and MongoDB and run locally - See here for detailed instructions

  2. install Docker and run in a container - See here for detailed instructions

Available Commands

  1. npm run dev - starts the development server with hot reloading enabled

  2. npm run build - bundles the code

  3. npm run test - start the test runner

  4. npm run start - runs production server

  5. npm run check-coverage - generates test coverage report

  6. npm run lint - runs standard to check for lint errors ( npm run fix to fix lint errors )

  7. 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.

#######################Running BDD Tests######################### cd e2e_tests npx codeceptjs run --grep "@smoke" --plugins allure
allure serve output

############### BDD Set Up ################################

//Refer https://codecept.io/bdd

MacOS

You may need to install selenium and webdriver brew install selenium-server-standalone brew install allure followed by selenium-server -port 4444

vly2's People

Contributors

aidanthedeveloper avatar alisamhh avatar ambomaya avatar andrew-meads avatar andrew-somervell avatar asomervell avatar aswinks88 avatar avowkind avatar cyrus-raitava avatar darcycox97 avatar dder725 avatar dependabot[bot] avatar eteroa123 avatar farjanacan avatar harrisonleach1 avatar harshanip avatar jgoodman-tec avatar jordansimsmith avatar joshmcarthur avatar michael-j-chinn avatar minhphu0304 avatar moniquewarrington avatar neoye911 avatar nzvorn avatar rushminatorr avatar stellaru avatar thjc avatar tia365 avatar waltzaround avatar zach-sim avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.